3.1.4.1.95 ApiGetNetInterface (Opnum 95)

  • Article

(Protocol Version 2) The ApiGetNetInterface method returns the name of the cluster network interface that is installed on the specified node and cluster network.

The server SHOULD accept an ApiGetNetInterface 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 ApiGetNetInterface(
   [in, string] LPCWSTR lpszNodeName,
   [in, string] LPCWSTR lpszNetworkName,
   [out, string] LPWSTR *lppszInterfaceName
 );

lpszNodeName: A null-terminated Unicode string that contains the computer name of the node on which to locate the cluster network interface.

lpszNetworkName: A null-terminated Unicode string that contains the name of the cluster network on which to locate the cluster network interface.

lppszInterfaceName: The address of a pointer that receives a pointer to a Unicode string buffer. The server MUST use the lppszInterfaceName parameter to return the name of the cluster network interface upon successful completion of this method. The server MUST allocate as much memory as is required to return the name. If the method fails, this parameter MUST be ignored.

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

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x000013B2

ERROR_CLUSTER_NODE_NOT_FOUND

A node that matches the name lpszNodeName was not found in the cluster configuration.

0x000013b7

ERROR_CLUSTER_NETINTERFACE_NOT_FOUND

A cluster network interface that matches the name lpszNetworkName was not found in the cluster configuration.

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.