CLUSCTL_NETINTERFACE_GET_CHARACTERISTICS control code

This control code retrieves the intrinsic characteristics of a network interface. Applications use this control code as a parameter to the ClusterNetInterfaceControl function.

ClusterNetInterfaceControl( 
  hNetInterface,                            // network interface handle
  hHostNode,                                // optional host node
  CLUSCTL_NETINTERFACE_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 ClusterNetInterfaceControl.

lpOutBuffer

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

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

Requirements

See also

Network Interface Control Codes

ClusterNetInterfaceControl

CLUS_CHARACTERISTICS