Skip to content

Latest commit

 

History

History
119 lines (94 loc) · 3.69 KB

nf-clusapi-openclustergroupex.md

File metadata and controls

119 lines (94 loc) · 3.69 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:clusapi.OpenClusterGroupEx
OpenClusterGroupEx function (clusapi.h)
Opens a failover cluster group and returns a handle to it. (OpenClusterGroupEx)
OpenClusterGroupEx
OpenClusterGroupEx function [Failover Cluster]
PCLUSAPI_OPEN_CLUSTER_GROUP_EX
PCLUSAPI_OPEN_CLUSTER_GROUP_EX function [Failover Cluster]
clusapi/OpenClusterGroupEx
clusapi/PCLUSAPI_OPEN_CLUSTER_GROUP_EX
mscs.openclustergroupex
mscs\openclustergroupex.htm
MsCS
240defbb-b9e9-4455-b863-c9b2192f12b7
12/05/2018
OpenClusterGroupEx, OpenClusterGroupEx function [Failover Cluster], PCLUSAPI_OPEN_CLUSTER_GROUP_EX, PCLUSAPI_OPEN_CLUSTER_GROUP_EX function [Failover Cluster], clusapi/OpenClusterGroupEx, clusapi/PCLUSAPI_OPEN_CLUSTER_GROUP_EX, mscs.openclustergroupex
clusapi.h
Windows
None supported
Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise
ClusAPI.lib
ClusAPI.dll
Windows
19H1
OpenClusterGroupEx
clusapi/OpenClusterGroupEx
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
OpenClusterGroupEx

OpenClusterGroupEx function

-description

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

-parameters

-param hCluster [in]

Handle to a cluster that includes the group to open.

-param lpszGroupName [in, optional]

Name of the group to open.

-param 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.

-param 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.

-returns

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).

-see-also

CloseClusterGroup

Group Management Functions

OpenClusterGroup