Skip to main content
CLUSCTL_NODE_GET_CHARACTERISTICS control code

Retrieves the intrinsic characteristics of a node. Applications use this control code as a ClusterNodeControl parameter.


ClusterNodeControl( 
  hNode,                            // node handle
  hHostNode,                        // optional host node
  CLUSCTL_NODE_GET_CHARACTERISTICS, // this control code
  NULL,                             // input buffer (not used)
  0,                                // input buffer size (not used)
  lpOutBuffer,                      // output buffer: DWORD bitmask
  cbOutBufferSize,                  // allocated buffer size (bytes)
  lpcbBytesReturned );              // actual size of resulting data (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, contains a DWORD bitmask describing the node's characteristics enumerated from the CLUS_CHARACTERISTICS enumeration. Only one bitmask is currently defined.

CLUS_CHAR_UNKNOWN (0x00000000)

The Network Interface has no known characteristics.

CLUS_CHAR_DELETE_REQUIRES_ALL_NODES (0x00000002)

Resources of this type cannot be deleted unless all nodes are active.

CLUS_CHAR_REQUIRES_STATE_CHANGE_REASON (0x00000010)

The resource DLL will receive the CLUSCTL_RESOURCE_STATE_CHANGE_REASON control code.

CLUS_CHAR_SINGLE_CLUSTER_INSTANCE (0x00000040)

Only one instance of this resource type is allowed in a cluster.

CLUS_CHAR_SINGLE_GROUP_INSTANCE (0x00000080)

Only one instance of this resource type is allowed in a group.

Return value

ClusterNodeControl returns one of the following values.

ERROR_SUCCESS

The operation completed successfully. This value is returned if the lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

More data is available. This value is returned if 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, the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_NODE_GET_CHARACTERISTICS 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_CHARACTERISTICS (0x5)

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
CLUS_CHARACTERISTICS