CLUSCTL_NETWORK_GET_CHARACTERISTICS control code

Retrieves the intrinsic characteristics of a network. Applications use this control code as a ClusterNetworkControl parameter.

ClusterNetworkControl( 
  hNetwork,                            // network handle
  hHostNode,                           // optional host node
  CLUSCTL_NETWORK_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 parameters are specific to this control code. For complete parameter descriptions, see ClusterNetworkControl.

hNetwork

Network handle.

hHostNode

Optional node handle. Can be NULL.

lpOutBuffer

On a successful return, contains a DWORD bitmask describing the network'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.

lpOutBufferSize

Allocated size (in bytes) of the output buffer.

lpcbBytesReturned

Returns the actual size (in bytes) of the data resulting from the operation.

Return value

ClusterNetworkControl returns one of the following values.

ERROR_SUCCESS

The operation was successful. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

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_NETWORK_GET_CHARACTERISTICS as follows (for more information, see Control Code Architecture).

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_NETWORK (0x5)
Global bit	23	CLUS_NOT_GLOBAL (0x0)
Modify bit	22	CLUS_NO_MODIFY (0x0)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_GET_CHARACTERISTICS (0x5)
Access code	0 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

Network Control Codes

ClusterNetworkControl

CLUS_CHARACTERISTICS