3.1.4.2.146 ApiCreateGroupSet (Opnum 163)

The ApiCreateGroupSet method<133> instructs the server to create a new group set object. The method establishes context on the server about the interaction of a client with a specified cluster group set by means of the current RPC connection. The method returns a context handle so that the client can refer to the group set in subsequent method calls.

The server MUST fail the method using ERROR_INVALID_NAME if lpszGroupSetName is empty.

The server MUST fail the method using ERROR_OBJECT_ALREADY_EXISTS if the group set name is the same as the name of a different group set.

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

The server MUST require that the client have a security access level of "All" (section 3.1.4).

 HGROUPSET_RPC
 ApiCreateGroupSet  (
   [ in, string ] LPCWSTR lpszGroupSetName,
   [ out ] error_status_t *Status,
   [ out ] error_status_t *rpc_status
 );

lpszGroupSetName: A Unicode string that is the name associated with the group set.

Status: Indicates the status of this operation. The server MUST set Status to the following error codes for the specified conditions.

Value

Meaning

0x00000000

ERROR_SUCCESS

Success

0x00000046

ERROR_SHARING_PAUSED

The remote server has been paused or is in the process of being started.

0x00001392

ERROR_OBJECT_ALREADY_EXISTS

See the preceding text for when this error can occur.

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether the runtime succeeded in executing this method on the server. The encoding of the value passed in this parameter MUST conform to encoding for comm_status and fault_status, as specified in Appendix E of [C706].

Return Values: The method MUST return a valid HGROUPSET_RPC context handle, as specified in section 2.2.1.11, to indicate success; otherwise, it MUST return NULL.