3.1.4.2.162 ApiCreateGroupSetEnum (Opnum 180)

The ApiCreateGroupSetEnum method<149> returns an enumeration of group sets in the current cluster.

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

The server SHOULD accept an ApiCreateGroupSetEnum request if the access level associated with the hCluster context handle is at least "Read" (section 3.1.4).

 error_status_t
 ApiCreateGroupSetEnum (
   [ in ] HCLUSTER_RPC hCluster,
   [ out ] PENUM_LIST *ReturnEnum,
   [ out ] error_status_t *rpc_status
 );

hCluster: An HCLUSTER_RPC (section 2.2.1.1) context handle that is obtained in a previous ApiOpenCluster (section 3.1.4.2.1) or ApiOpenClusterEx (section 3.1.4.2.116) method call.

ReturnEnum: A pointer to a PENUM_LIST, as specified in section 2.2.3.5. The server MUST allocate as much memory as is required to return the enumeration data. If the method fails, this parameter MUST be ignored.

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 the following error codes for the specified conditions.

Return value/code	Description
0x00000000 ERROR_SUCCESS	Success.
0x00000008 ERROR_NOT_ENOUGH_MEMORY	The server failed to allocate enough memory for the ReturnEnum parameter.

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. However, the client SHOULD treat errors specified in section 3.2.4.6 as recoverable errors, and initiate the reconnect procedure as specified in section 3.2.4.6.