CLUSCTL_NODE_GET_ID control code

Retrieves the unique cluster identifier for a node. Applications use this control code as a ClusterNodeControl parameter.


ClusterNodeControl(hNode,             // node handle
                  hHostNode,          // optional host node
                  CLUSCTL_NODE_GET_ID,// this control code
                  NULL,               // input buffer (not used)
                  0,                  // input buffer size (not used)
                  lpOutBuffer,        // output buffer: string
                  cbOutBufferSize,    // allocated buffer size (bytes)
                  lpcbBytesReturned );// resulting data size (bytes)

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterNodeControl.

lpOutBuffer

On a successful return, points to a null-terminated Unicode string containing the number that identifies the node.

Return value

ClusterNodeControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

The number returned in lpOutBuffer resides in the cluster database under HKEY_LOCAL_MACHINE\Cluster\Nodes.

ClusAPI.h defines the 32 bits of CLUSCTL_NODE_GET_ID as follows (for more information, see Control Code Architecture).

ComponentBit locationValue
Object code24–31

CLUS_OBJECT_NODE (0x4)

Global bit23

CLUS_NOT_GLOBAL (0x0)

Modify bit22

CLUS_NO_MODIFY (0x0)

User bit21

CLCTL_CLUSTER_BASE (0x0)

Type bit20

External (0x0)

Operation code0–23

CLCTL_GET_ID (0x39)

Access code0–1

CLUS_ACCESS_READ (0x1)

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

Header

ClusAPI.h

See also

Node Control Codes
ClusterNodeControl

 

 

Show: