3.1.4.2.85 ApiCreateNetworkEnum (Opnum 85)

(Protocol Version 3) The ApiCreateNetworkEnum method returns a collection of cluster network interface names from the cluster state that are installed on the cluster network that is specified by hNetwork.

The server SHOULD accept an ApiCreateNetworkEnum 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 server SHOULD accept an ApiCreateNetworkEnum request if the access level associated with the hNetwork context handle is at least "Read" (section 3.1.4).

 error_status_t ApiCreateNetworkEnum(
   [in] HNETWORK_RPC hNetwork,
   [in] DWORD dwType,
   [out] PENUM_LIST *ReturnEnum,
   [out] error_status_t *rpc_status
 );

hNetwork: An HNETWORK_RPC context handle that was obtained in a previous ApiOpenNetwork or ApiOpenNetworkEx method call.

dwType: The type of enumeration to be returned by the server. The client MUST set dwType to the following value.

Value

Meaning

CLUSTER_NETWORK_ENUM_NETINTERFACES

0x00000001

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

ReturnEnum: A pointer to a PENUM_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.

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.

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

Show: