3.1.4.2.151 ApiRemoveGroupFromGroupSet (Opnum 168)

The ApiRemoveGroupFromGroupSet method<138> instructs the server to remove the designated group from a group set. The nonvolatile cluster state associated with this group is updated.

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

The server SHOULD require that the access level associated with the Group context handle is "All" (section 3.1.4).

 error_status_t
 ApiRemoveGroupFromGroupSet (
   [ in ] HGROUP_RPC Group,
   [ out ] error-status_t *rpc_status
 );

Group: An HGROUP_RPC (section 2.2.1.3) context handle that was obtained in a previous ApiCreateGroupSet (section 3.1.4.2.146) or ApiOpenGroupSet (section 3.1.4.2.147) method call.

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
0x00000006 ERROR_INVALID_HANDLE	The Group parameter does not represent a valid HGROUP_RPC context handle.
0x00000032 ERROR_NOT_SUPPORTED	The request is not supported.
0x00000091 ERROR_DIR_NOT_EMPTY	One or more resources are contained in the group set represented by Group.
0x00000428 ERROR_EXCEPTION_IN_SERVICE	An exception occurred in the service when handling the control request.
0x00001394 ERROR_GROUP_NOT_AVAILABLE	The group represented by the Group parameter is not available in the cluster.
0x0000139F ERROR_INVALID_STATE	The group or resource is not in the correct state to perform the requested operation.
0x000013D1 ERROR_CLUSTER_NODE_SHUTTING_DOWN	The cluster node is shutting down in cluster group represented by Group.

For any other condition, the server MUST set rpc_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 3.2.4.6.

The server SHOULD return ERROR_GROUP_NOT_FOUND if the server determines that the group represented by the Group parameter has already been deleted. This is determined while communicating with other servers to delete the group from the nonvolatile cluster state. The manner of determination is implementation-specific.