OpenClusterGroupEx function (clusapi.h)

Opens a failover cluster group and returns a handle to it.

Syntax

HGROUP OpenClusterGroupEx(
  [in]            HCLUSTER hCluster,
  [in, optional]  LPCWSTR  lpszGroupName,
  [in]            DWORD    dwDesiredAccess,
  [out, optional] DWORD    *lpdwGrantedAccess
);

Parameters

[in] hCluster

Handle to a cluster that includes the group to open.

[in, optional] lpszGroupName

Name of the group to open.

[in] dwDesiredAccess

The requested access privileges. This may be any combination of GENERIC_READ (0x80000000), GENERIC_ALL (0x10000000), or MAXIMUM_ALLOWED (0x02000000). If this value is zero (0) and undefined error may be returned. Using GENERIC_ALL is the same as calling OpenClusterGroup.

[out, optional] lpdwGrantedAccess

Optional parameter that contains the address of a DWORD that will receive the access rights granted. If the DesiredAccess parameter is MAXIMUM_ALLOWED (0x02000000) then the DWORD pointed to by this parameter will contain the maximum privileges granted to this user.

Return value

If the operation was successful, OpenClusterGroupEx returns a group handle.

Return code	Description
NULL	The operation was not successful. For more information about the error, call the GetLastError function. If the target server does not support the OpenClusterGroupEx function (for example if the target server is running Windows Server 2008 or earlier) then the GetLastError function will return RPC_S_PROCNUM_OUT_OF_RANGE (1745).

Requirements

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

See also

CloseClusterGroup

Group Management Functions

OpenClusterGroup