3.1.4.1.86 ApiGetNetworkId (Opnum 86)

(Protocol Version 2) The ApiGetNetworkId method returns the unique ID of the specified cluster network.

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

 error_status_t ApiGetNetworkId(
   [in] HNETWORK_RPC hNetwork,
   [out, string] LPWSTR *pGuid
 );

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

pGuid: The address of a pointer that receives a pointer to a Unicode string buffer where the server MUST return the unique ID of the cluster network after 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. <61>

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 hNetwork parameter does not represent a valid HNETWORK_RPC context handle.
0x000013AB ERROR_NETWORK_NOT_AVAILABLE	The cluster network represented by the hNetwork parameter no longer exists in the non-volatile cluster state.

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.