Export (0) Print
Expand All
Expand Minimize ApiGetNodeState (Opnum 68)

(Protocol Version 2) The ApiGetNodeState method returns the current state of the specified node.

The server SHOULD accept an ApiGetNodeState 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.

The state of a node SHOULD change according to implementation-specific methods and protocols between servers, such as when other active nodes detect that a configured node is active or has failed. A client MAY query the current state of a node.

error_status_t ApiGetNodeState(
  [in] HNODE_RPC hNode,
  [out] DWORD* State

hNode: An HNODE_RPC context handle that was obtained in a previous ApiOpenNode method.

State: The current state of the node, which is written by the server after successful completion of this method. If the method fails, this parameter MUST be ignored. If the method succeeds, this field MUST be set to one of the following values.

Value Meaning


The node is active.


The node is not active.


The node is in the process of becoming active by joining a cluster.


The node is active, but it has temporarily suspended activity, as specified in section


The operation to retrieve the node state was not successful.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code Description




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

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

© 2014 Microsoft