3.1.4.2.84 ApiSetNetworkName (Opnum 84)

(Protocol Version 3) The ApiSetNetworkName method sets the name of the cluster network represented by the hNetwork parameter to the string represented by the lpszNetworkName parameter. The nonvolatile cluster state associated with this cluster network is updated.

The server MUST fail this method using ERROR_ALREADY_EXISTS if the specified name is already the name or ID of a cluster network.

The server MUST accept an ApiSetNetworkName request for processing only if it is in the read/write state, as specified in section 3.1.1.

The server MUST require that the access level associated with the hNetwork context handle is "All" (section 3.1.4).

 error_status_t ApiSetNetworkName(
   [in] HNETWORK_RPC hNetwork,
   [in, string] LPCWSTR lpszNetworkName,
   [out] error_status_t *rpc_status
 );

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

lpszNetworkName: A pointer to a Unicode string that contains the new name of the cluster network.<86>

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.
0x00000006 ERROR_INVALID_HANDLE	The data that is pointed to by the hNetwork parameter does not represent a valid HNETWORK_RPC context handle.
0x0000007B ERROR_INVALID_NAME	The name pointed to by the lpszNetworkName parameter MUST contain at least one character.
0x000000B7 ERROR_ALREADY_EXISTS	See the preceding text for when this error can occur.
0x000013AB ERROR_NETWORK_NOT_AVAILABLE	The cluster network represented by the hNetwork parameter no longer exists in the nonvolatile cluster state.

For any other condition, the server MUST set Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section 3.2.4.6.