IAzClientContext::GetProperty method (azroles.h)

The GetProperty method returns the IAzClientContext object property with the specified property ID.

Syntax

HRESULT GetProperty(
  [in]           LONG    lPropId,
  [in, optional] VARIANT varReserved,
  [out]          VARIANT *pvarProp
);

Parameters

[in] lPropId

Property ID of the IAzClientContext object property to return. The following table shows the possible values.

Value Meaning
AZ_PROP_CHILD_CREATE
Determines whether the current user has permission to create child objects. This value will always be FALSE because this object cannot have child objects.
AZ_PROP_CLIENT_CONTEXT_ROLE_FOR_ACCESS_CHECK
Also accessed through the RoleForAccessCheck property
AZ_PROP_CLIENT_CONTEXT_USER_CANONICAL
Also accessed through the UserCanonical property
AZ_PROP_CLIENT_CONTEXT_USER_DISPLAY
Also accessed through the UserDisplay property
AZ_PROP_CLIENT_CONTEXT_USER_DN
Also accessed through the UserDn property
AZ_PROP_CLIENT_CONTEXT_USER_DNS_SAM_COMPAT
Also accessed through the UserDnsSamCompat property
AZ_PROP_CLIENT_CONTEXT_USER_GUID
Also accessed through the UserGuid property
AZ_PROP_CLIENT_CONTEXT_USER_SAM_COMPAT
Also accessed through the UserSamCompat property
AZ_PROP_CLIENT_CONTEXT_USER_UPN
Also accessed through the UserUpn property

[in, optional] varReserved

Reserved for future use.

[out] pvarProp

A pointer to the returned IAzClientContext object property.

Return value

The return value is an HRESULT. A value of S_OK indicates success. Any other value indicates that the operation failed.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header azroles.h
Library Azroles.lib
DLL Azroles.dll
Redistributable Windows Server 2003 Administration Tools Pack on Windows XP