Edit

Share via

SetClusterName function (clusapi.h)

  • Article

Sets the name for a cluster. The PCLUSAPI_SetClusterName type defines a pointer to this function.

Syntax

DWORD SetClusterName(
  [in] HCLUSTER hCluster,
  [in] LPCWSTR  lpszNewClusterName
);

Parameters

[in] hCluster

Handle to a cluster to rename.

[in] lpszNewClusterName

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

Return value

If the operation succeeds, the function returns ERROR_RESOURCE_PROPERTIES_STORED.

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

Remarks

The cluster name is stored in the Name private property of the core Network Name resource (that is, the Network Name resource of the cluster). Because of possible dependencies on this resource, the change is not effective until the Network Name resource is brought back online.

Do not call SetClusterName from a resource DLL. For more information, see Function Calls to Avoid in Resource DLLs.

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

See also

Name