3.1.4.2.51 ApiOfflineGroup (Opnum 50)

(Protocol Version 3) The ApiOfflineGroup method instructs the server to make all the resources in the designated group inactive or unavailable on the node that is hosting the group. The group's persistent state is set to offline and is updated in the non-volatile cluster state.

The server MUST attempt to make all resources in the group inactive or unavailable as specified in section 3.1.4.2.19.

The server fails this method using the error ERROR_CLUSTER_RESOURCE_LOCKED_STATUS if the group is in locked mode, as specified in section 3.1.1.1.4.

The server MUST accept an ApiOfflineGroup 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 access level associated with the hGroup context handle is "All" (section 3.1.4).

 error_status_t ApiOfflineGroup(
   [in] HGROUP_RPC hGroup,
   [out] error_status_t *rpc_status
 );

hGroup: An HGROUP_RPC (section 2.2.1.3) context handle that was obtained in a previous ApiOpenGroup (section 3.1.4.2.42), ApiOpenGroupEx (section 3.1.4.2.118), or ApiCreateGroup (section 3.1.4.2.43) 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 it succeeded in executing this method on the server by writing to this parameter. 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 hGroup parameter does not represent a valid HGROUP_RPC context handle.
0x000003E5 ERROR_IO_PENDING	The server is in the process of making the group's resources inactive or unavailable.
0x00001394 ERROR_GROUP_NOT_AVAILABLE	The group represented by the hGroup parameter no longer exists in the non-volatile cluster state.
0x0000055C ERROR_SPECIAL_GROUP	The server cannot perform this operation on this built-in special group (section 3.1.1.1.4).
0x0000139F ERROR_INVALID_STATE	The group or resource is not in the correct state to perform the requested operation.

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