NDIS_SWITCH_PORT_ARRAY structure (ntddndis.h)

Article
05/26/2021

The NDIS_SWITCH_PORT_ARRAY structure specifies an array of port configuration parameters. Each element in the array specifies the parameters for a Hyper-V extensible switch port. Each element is formatted as an NDIS_SWITCH_PORT_PARAMETERS structure.

Syntax

typedef struct _NDIS_SWITCH_PORT_ARRAY {
  NDIS_OBJECT_HEADER Header;
  ULONG              Flags;
  USHORT             FirstElementOffset;
  ULONG              NumElements;
  ULONG              ElementSize;
} NDIS_SWITCH_PORT_ARRAY, *PNDIS_SWITCH_PORT_ARRAY;

Members

Header

The type, revision, and size of the NDIS_SWITCH_PORT_ARRAY structure. This member is formatted as an NDIS_OBJECT_HEADER structure.

The Type member of Header must be set to NDIS_OBJECT_TYPE_DEFAULT. To specify the version of the NDIS_SWITCH_PORT_ARRAY structure, the Revision member of Header must be set to the following value:

NDIS_SWITCH_PORT_ARRAY_REVISION_1

Original version for NDIS 6.30 and later.

Set the Size member to NDIS_SIZEOF_NDIS_SWITCH_PORT_ARRAY_REVISION_1.

Flags

A ULONG value that contains a bitwise OR of flags. This member is reserved for NDIS.

FirstElementOffset

A USHORT value that specifies the offset, in bytes, to the first element in an array of elements that follow this structure. The offset is measured from the start of the NDIS_SWITCH_PORT_ARRAY structure up to the beginning of the first element. Each element in the array is an NDIS_SWITCH_PORT_PARAMETERS structure.

Note If NumElements is set to zero, this member is ignored.

NumElements

A ULONG value that specifies the number of NDIS_SWITCH_PORT_PARAMETERS elements that follow the NDIS_SWITCH_PORT_ARRAY structure.

ElementSize

A ULONG value that specifies the size, in bytes, of the NDIS_SWITCH_PORT_PARAMETERS elements that follows the NDIS_SWITCH_PORT_ARRAY structure.

Remarks

The NDIS_SWITCH_PORT_ARRAY structure is returned in OID query requests of OID_SWITCH_PORT_ARRAY. An array of NDIS_SWITCH_PORT_PARAMETERS structures follow the NDIS_SWITCH_PORT_ARRAY structure in the information buffer that is associated with these OID query requests. The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to this information buffer.

Extensible switch extensions can access individual NDIS_SWITCH_PORT_PARAMETERS elements inside an NDIS_SWITCH_PORT_ARRAY structure by using the NDIS_SWITCH_PORT_AT_ARRAY_INDEX macro.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.30 and later.
Header	ntddndis.h (include Ndis.h, Fwpsk.h)