OpenClusterNodeEx function (clusapi.h)

Opens a node and returns a handle to it.


HNODE OpenClusterNodeEx(
  [in]            HCLUSTER hCluster,
  [in, optional]  LPCWSTR  lpszNodeName,
  [in]            DWORD    dwDesiredAccess,
  [out, optional] DWORD    *lpdwGrantedAccess


[in] hCluster

Handle to a cluster returned from the OpenCluster or OpenClusterEx functions.

[in, optional] lpszNodeName

Pointer to the NetBIOS name of an existing node. If the DNS name of the node is used, the OpenClusterNodeEx function will fail and GetLastError will return ERROR_CLUSTER_NODE_NOT_FOUND.

[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 OpenClusterNode.

[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, OpenClusterNodeEx returns a node handle.

Return code Description
The operation was not successful. For more information about the error, call the GetLastError function. If the target server does not support the OpenClusterNodeEx 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).


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


Node Management Functions