SetClusterGroupName function (clusapi.h)

Sets the name for a group. The PCLUSAPI_SET_CLUSTER_GROUP_NAME type defines a pointer to this function.


DWORD SetClusterGroupName(
  [in] HGROUP  hGroup,
  [in] LPCWSTR lpszGroupName


[in] hGroup

Handle to the group to name.

[in] lpszGroupName

Pointer to the new name for the group identified by hGroup.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

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


SetClusterGroupName changes the Name common property of the group identified by hGroup. This is the only way that Name, a read-only property, can be changed.

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


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