SetClusterNetworkName function (clusapi.h)

Article
02/22/2024

Sets the name for a network. The PCLUSAPI_SET_CLUSTER_NETWORK_NAME type defines a pointer to this function.

Syntax

DWORD SetClusterNetworkName(
  [in] HNETWORK hNetwork,
  [in] LPCWSTR  lpszName
);

Parameters

[in] hNetwork

Handle to a network to name.

[in] lpszName

Pointer to a null-terminated Unicode string containing the new network name.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code.

Remarks

SetClusterNetworkName changes the Name common property of the network identified by hNetwork. This is the only way that Name, a read-only property, can be changed.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll