Share via

3.1.4.1.2 ApiCloseCluster (Opnum 1)

  • Article

(Protocol Version 2) The ApiCloseCluster method instructs the server to free any context information that is created in a previous ApiOpenCluster method call.

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

 error_status_t ApiCloseCluster(
   [in, out] HCLUSTER_RPC *Cluster
 );

Cluster: A pointer to an HCLUSTER_RPC context handle that is obtained in a previous ApiOpenCluster method call. Upon success, the server MUST set to NULL the context handle that this parameter points to. Upon failure, the client MUST ignore the context handle to which this parameter points.

Return Values: The method MUST return the following error codes for the conditions that are specified in the following table.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x00000006

ERROR_INVALID_HANDLE

The data that is pointed to by the Cluster parameter does not represent a valid HCLUSTER_RPC context handle.

For any other condition, this method MUST return a value that is not 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.