NDIS_OPEN_PARAMETERS (Compact 7)

3/12/2014

This structure defines the open parameters when a protocol driver calls the NdisOpenAdapterEx function.

Syntax

typedef struct _NDIS_OPEN_PARAMETERS {
  NDIS_OBJECT_HEADER  Header;
  PNDIS_STRING  AdapterName;
  PNDIS_MEDIUM  MediumArray;
  UINT  MediumArraySize;
  PUINT  SelectedMediumIndex;
  PNET_FRAME_TYPE  FrameTypeArray;
  UINT  FrameTypeArraySize;
} NDIS_OPEN_PARAMETERS, *PNDIS_OPEN_PARAMETERS;

Members

• Header
  The NDIS_OBJECT_HEADER structure for the NDIS_OPEN_PARAMETERS structure. Set the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_OPEN_PARAMETERS, the Revision member to NDIS_OPEN_PARAMETERS_REVISION_1, and the Size member to the NDIS_SIZEOF_OPEN_PARAMETERS_REVSION_1.

• AdapterName
  A Unicode string that contains the name of the miniport adapter that NDIS passed to ProtocolBindAdapterEx in the AdapterName member of the BindParameters parameter. This name can identify a physical adapter (that is, a network adapter) or a virtual adapter that is associated with an intermediate driver.

• MediumArray
  A pointer to an array of NdisMediumXxx values that lists the types of media the caller can support. This list is a subset of the NDIS NDIS NdisMediumXxx Types types.

• MediumArraySize
  The number of elements in the MediumArray member.

• SelectedMediumIndex
  A pointer to a driver-provided UINT variable that contains an index into the MediumArray array. NDIS writes this index which identifies the media type that the underlying driver uses.

• FrameTypeArray
  A pointer to an array of NET_FRAME_TYPE values, specifying the frame types that you want the protocol driver to receive. The frame type is a USHORT value that follows the destination and source MAC address in Ethernet frames. In the presence of VLAN tags, this value follows the destination, source MAC address, and VLAN tag. NET_FRAME_TYPE is defined as follows:

  • typedef USHORT NET_FRAME_TYPE;
  • typedef NET_FRAME_TYPE *PNET_FRAME_TYPE;

  Note

  NDIS uses the frame type values that the protocol driver provides in this array as a hint to optimize the receive indications that NDIS sends to the protocol driver. NDIS does not guarantee that a protocol driver will receive only packets with frame types that match the types in the array.

• FrameTypeArraySize
  The number of elements in the FrameTypeArray member. This number must be equal to or less than NDIS_MAX_FRAME_TYPES_PER_OPEN.

Remarks

A protocol driver passes an NDIS_OPEN_PARAMETERS structure when it calls the NdisOpenAdapterEx function to open a miniport adapter.

Requirements

See Also

Reference

NDIS Protocol Driver Structures
NDIS_OBJECT_HEADER
NdisOpenAdapterEx
ProtocolBindAdapterEx