OpenClusterGroupEx function

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

Syntax


HGROUP WINAPI OpenClusterGroupEx(
  _In_      HCLUSTER hCluster,
  _In_opt_  LPCWSTR  lpszGroupName,
  _In_      DWORD    dwDesiredAccess,
  _Out_opt_ DWORD    *lpdwGrantedAccess
);

typedef HGROUP (WINAPI *PCLUSAPI_OPEN_CLUSTER_GROUP_EX)(
    _In_      HCLUSTER hCluster,
    _In_opt_  LPCWSTR  lpszGroupName,
    _In_      DWORD    dwDesiredAccess,
    _Out_opt_ LPDWORD  lpdwGrantedAccess
);

Parameters

hCluster [in]

Handle to a cluster that includes the group to open.

lpszGroupName [in, optional]

Name of the group to open.

dwDesiredAccess [in]

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.

lpdwGrantedAccess [out, optional]

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.

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise

Header

ClusAPI.h

Library

ClusAPI.lib

DLL

ClusAPI.dll

See also

Group Management Functions
CloseClusterGroup
OpenClusterGroup

 

 

Show: