Share via

3.1.4.1.101 ApiCreateNodeEnum (Opnum 101)

  • Article

(Protocol Version 2) The ApiCreateNodeEnum method returns a collection of named objects in the cluster state associated with a particular node.

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

 error_status_t ApiCreateNodeEnum(
   [in] HNODE_RPC hNode,
   [in] DWORD dwType,
   [out] PENUM_LIST *ReturnEnum
 );

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

dwType: The type of enumeration to be returned by the server. The client MUST set dwType to the bit-wise OR operator of one or more of the following values.

Value

Meaning

CLUSTER_NODE_ENUM_NETINTERFACES

0x00000001

Return an enumeration of one or more cluster network interface names that represent the cluster network interfaces that are installed on the specified node.

ReturnEnum: A pointer to an ENUM_LIST, as specified in section 2.2.3.5, that contains the data that matches the enumeration type that is indicated by the dwType parameter. The server MUST allocate as much memory as is required to return the enumeration data. If the method fails, this parameter MUST be ignored.

If the client sets dwType to a value other than as specified above, the server SHOULD ignore all bits in dwType except those that match the bit(s) in allowable dwType values and complete the method successfully, provided no other failure conditions are met.

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

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

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.