3.1.4.2.96 ApiGetNetInterfaceId (Opnum 96)

(Protocol Version 3) The ApiGetNetInterfaceId method returns the unique ID of the specified cluster network interface.

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

The server SHOULD accept an ApiGetNetInterfaceId request if the access level associated with the hNetInterface context handle is at least "Read" (section 3.1.4).

 error_status_t ApiGetNetInterfaceId(
   [in] HNETINTERFACE_RPC hNetInterface,
   [out, string] LPWSTR *pGuid,
   [out] error_status_t *rpc_status
 );

hNetInterface: An HNETINTERFACE_RPC context handle that was obtained in a previous ApiOpenNetInterface or ApiOpenNetInterfaceEx method call.

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

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether it 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.
0x00000006 ERROR_INVALID_HANDLE	The data that is pointed to by the hNetInterface parameter does not represent a valid HNETINTERFACE_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 3.2.4.6 as recoverable errors and initiate the reconnect procedure as specified in section 3.2.4.6.