ApiGetGroupId (Opnum 47)

(Protocol Version 2) The ApiGetGroupId method returns the unique ID of the designated group.

The server SHOULD accept an ApiGetGroupId request if its protocol server state is read-only, and MUST accept the request for processing if it is in the read/write state, as specified in section 3.1.1.

 error_status_t ApiGetGroupId(
   [in] HGROUP_RPC hGroup,
   [out, string] LPWSTR *pGuid

hGroup: An HGROUP_RPC context handle that was obtained in a previous ApiOpenGroup or ApiCreateGroup method call.

pGuid: The address of a pointer that receives a pointer to a Unicode string buffer where the server MUST return the unique ID of the group after successful completion of this method. The server MUST allocate as much memory as is required to return the ID. If the method fails, this parameter MUST be ignored.<59>

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code







The hGroup parameter does not represent a valid HGROUP_RPC context handle.



The group represented by the hGroup parameter no longer exists in the non-volatile cluster state.

For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in one consistent, identical manner for all values that are not listed in the preceding table. The client SHOULD treat errors specified in as recoverable errors and initiate the reconnect procedure as specified in section