Export (0) Print
Expand All
Expand Minimize

3.1.4.1.84 ApiSetNetworkName (Opnum 84)

(Protocol Version 2) 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 by using error ERROR_OBJECT_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.

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

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

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

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.

0x00001392
ERROR_OBJECT_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.

 
Show:
© 2014 Microsoft