Skip to main content
Gets information about a group and its roles

Syntax

Parameters

entityHandle   PFEntityHandle PFEntityHandle to use for authentication. request   PFGroupsGetGroupRequest* Populated request object. async   XAsyncBlock*
Inout
XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on all platforms. Returns the ID, name, role list and other non-membership related information about a group. See also GroupUpdateGroupAsync. When the asynchronous task is complete, call PFGroupsGetGroupGetResultSize and PFGroupsGetGroupGetResult to get the result.

Requirements

Header: PFGroups.h

See also

PFGroups members
Last modified on August 1, 2026