3.1.4.2.4 ApiGetClusterName (Opnum 3)

(Protocol Version 3) The ApiGetClusterName method returns the cluster name and the computer name of the node that is acting as an RPC interface server.

The server SHOULD accept an ApiGetClusterName 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 ApiGetClusterName request if the client's access level is at least "Read" (section 3.1.4).

 error_status_t ApiGetClusterName(
   [out, string] LPWSTR *ClusterName,
   [out, string] LPWSTR *NodeName
 );

ClusterName: The address of a pointer where the server MUST, on successful completion of this method, write the address of a case-insensitive Unicode string buffer containing the cluster name. The server MUST attempt to allocate as much memory as is required to return the cluster name. If the method fails, this parameter MUST be ignored.

NodeName: The address of a pointer that receives the address of a Unicode string where the server MUST, on successful completion of this method, write the address of a Unicode string buffer containing the computer 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.
0x00000008 ERROR_NOT_ENOUGH_MEMORY	The server failed to allocate enough memory for the ClusterName parameter or the NodeName parameter.

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. However, 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.