Export (0) Print
Expand All
Expand Minimize ApiSetGroupName (Opnum 46)

(Protocol Version 2) The ApiSetGroupName method sets the name of the designated group to the specified name. The non-volatile cluster state associated with the group is updated.

The server MUST fail this method by using error ERROR_ALREADY_EXISTS if the specified name is already used as either the name or the id of another group.

The server MUST accept an ApiSetGroupName request for processing only if it is in the read/write state, as specified in section 3.1.1.

error_status_t ApiSetGroupName(
  [in] HGROUP_RPC hGroup,
  [in, string] LPCWSTR lpszGroupName

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

lpszGroupName: A pointer to a Unicode string that contains the new name of the group.

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

Return value/code Description




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


The name pointed to by the lpszGroupName parameter MUST contain at least one character.


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


See the preceding text for when this error can occur.

For any other condition, the server MUST set Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section

© 2014 Microsoft