Edit

IAzClientContext3::GetGroups method (azroles.h)

  • Article

The GetGroups method returns an array of the application groups associated with this client context.

Syntax

HRESULT GetGroups(
  [in]  BSTR    bstrScopeName,
  [in]  ULONG   ulOptions,
  [out] VARIANT *pGroupArray
);

Parameters

[in] bstrScopeName

The name of the scope in which to check for application groups. This parameter is ignored if the value of the ulOptions parameter is set to AZ_CLIENT_CONTEXT_GET_GROUPS_STORE_LEVEL_ONLY.

[in] ulOptions

A set of flags that modify the behavior of this method. This can be zero or a combination of one or more of the following values.

Value Meaning
AZ_CLIENT_CONTEXT_GET_GROUPS_STORE_LEVEL_ONLY
0x2
 This method checks only for application groups at the store level.

[out] pGroupArray

A pointer to an array of the names of application groups associated with this client context.

This is a variant that contains either a SAFEARRAY or the JScript Array object. Each element of the array holds a VT_BSTR that contains the name of an application group.

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

See also

IAzClientContext3