Skip to content

Latest commit

 

History

History
114 lines (80 loc) · 3.87 KB

nf-clusapi-getnodeclusterstate.md

File metadata and controls

114 lines (80 loc) · 3.87 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.GetNodeClusterState
GetNodeClusterState function (clusapi.h)
Determines whether the Cluster service is installed and running on a node.
ClusterStateNotConfigured
ClusterStateNotInstalled
ClusterStateNotRunning
ClusterStateRunning
GetNodeClusterState
GetNodeClusterState function [Failover Cluster]
PCLUSAPI_GET_NODE_CLUSTER_STATE
PCLUSAPI_GET_NODE_CLUSTER_STATE function [Failover Cluster]
_wolf_getnodeclusterstate
clusapi/GetNodeClusterState
clusapi/PCLUSAPI_GET_NODE_CLUSTER_STATE
mscs.getnodeclusterstate
mscs\getnodeclusterstate.htm
MsCS
67534bc8-f19e-4330-850a-788a7f031f5b
12/05/2018
ClusterStateNotConfigured, ClusterStateNotInstalled, ClusterStateNotRunning, ClusterStateRunning, GetNodeClusterState, GetNodeClusterState function [Failover Cluster], PCLUSAPI_GET_NODE_CLUSTER_STATE, PCLUSAPI_GET_NODE_CLUSTER_STATE function [Failover Cluster], _wolf_getnodeclusterstate, clusapi/GetNodeClusterState, clusapi/PCLUSAPI_GET_NODE_CLUSTER_STATE, mscs.getnodeclusterstate
clusapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
ClusAPI.lib
ClusAPI.dll
Windows
19H1
GetNodeClusterState
clusapi/GetNodeClusterState
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-0.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-1.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-2.dll
ext-ms-win-cluster-clusapi-l1-1-3.dll
GetNodeClusterState

GetNodeClusterState function

-description

Determines whether the Cluster service is installed and running on a node. The PCLUSAPI_GET_NODE_CLUSTER_STATE type defines a pointer to this function.

-parameters

-param lpszNodeName [in, optional]

Pointer to a null-terminated Unicode string containing the name of the node to query. If lpszNodeName is NULL, the local node is queried.

-param pdwClusterState [out]

Pointer to a value describing the state of the Cluster service on the node. A node will be described by one of the following NODE_CLUSTER_STATE enumeration values.

ClusterStateNotInstalled (0)

The Cluster service is not installed on the node.

ClusterStateNotConfigured (1)

The Cluster service is installed on the node but has not yet been configured.

ClusterStateNotRunning (3)

The Cluster service is installed and configured on the node but is not currently running.

ClusterStateRunning (19 (0x13))

The Cluster service is installed, configured, and running on the node.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS (0). If the operation fails, the function returns a system error code.

-remarks

Note  The GetNodeClusterState function does not support a 64-bit Windows-based node if the calling application is 32-bit Windows-based.

-see-also

NODE_CLUSTER_STATE

Node Management Functions