Edit

Share via

IAzClientContext3::IsInRoleAssignment method (azroles.h)

  • Article

The IsInRoleAssignment method checks whether the principal represented by the current client context is a member of the specified role in the specified scope.

Syntax

HRESULT IsInRoleAssignment(
  [in]  BSTR         bstrScopeName,
  [in]  BSTR         bstrRoleName,
  [out] VARIANT_BOOL *pbIsInRole
);

Parameters

[in] bstrScopeName

The name of the scope to check.

[in] bstrRoleName

The name of the role to check.

[out] pbIsInRole

VARIANT_TRUE if the principal represented by the current client context is a member of the role specified by the bstrRoleName parameter in the scope specified by the bstrScopeName parameter; otherwise, VARIANT_FALSE.

Return value

If the method succeeds, it returns S_OK.

If the method fails, it returns an error code. For a list of common error codes, see Common HRESULT Values.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header azroles.h