Share via

NDIS_PROTOCOL_RESTART_PARAMETERS (Compact 2013)

  • Article

3/26/2014

This structure defines restart parameters for a protocol driver when NDIS calls the ProtocolNetPnPEvent function to indicate a NetEventRestart event.

Syntax

typedef struct _NDIS_PROTOCOL_RESTART_PARAMETERS {
  NDIS_OBJECT_HEADER  Header;
  PUCHAR  FilterModuleNameBuffer;
  ULONG  FilterModuleNameBufferLength;
  PNDIS_RESTART_ATTRIBUTES  RestartAttributes;
  NET_IFINDEX  BoundIfIndex;
  NET_LUID  BoundIfNetluid;
  ULONG  Flags;
} NDIS_PROTOCOL_RESTART_PARAMETERS, *PNDIS_PROTOCOL_RESTART_PARAMETERS;

Members

  • Header
    The NDIS_OBJECT_HEADER structure for the NDIS_PROTOCOL_RESTART_PARAMETERS structure. NDIS sets the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_PROTOCOL_RESTART_PARAMETERS, the Revision member to NDIS_PROTOCOL_RESTART_PARAMETERS_REVISION_1, and the Size member to NDIS_SIZEOF_PROTOCOL_RESTART_PARAMETERS_REVISION_1.
  • FilterModuleNameBuffer
    A list of the names of the underlying filter modules. For each name, the buffer contains a USHORT value followed by a wide character string. Use the first USHORT value in the buffer to determine the length of the first string. Use the length of the first string to determine the start of the next string. Continue in this manner until the number of bytes that are retrieved from the buffer equals the number of bytes that are specified in the FilterModuleNameBufferLength member.
  • FilterModuleNameBufferLength
    The length, in bytes, of the buffer in the FilterModuleNameBuffer member.
  • RestartAttributes
    A pointer to the first entry in a list of NDIS_RESTART_ATTRIBUTES structures. Use the Next member of the NDIS_RESTART_ATTRIBUTES structure to obtain the next structure in the list.
  • BoundIfNetluid
    The NDIS NET_LUID value (that is also the network interface name (ifName in RFC 2863)) of the highest-level interface that is stacked on the miniport adapter. That is, if there are virtual miniports or filter modules that are installed over the miniport adapter, this member is the NET_LUID value of the highest-level virtual miniport or filter module.
  • BoundIfIndex
    The NDIS network interface index of the highest-level interface that is stacked on the miniport adapter. That is, if there are virtual miniports or filter modules that are installed over the miniport adapter, this member is the ifIndex of the highest-level virtual miniport or filter module.
  • Flags
    Reserved.

Remarks

NDIS passes an NDIS_PROTOCOL_RESTART_PARAMETERS structure to a protocol driver when it calls the ProtocolNetPnPEvent function to indicate a NetEventRestart event.

Each name that is specified in the buffer in the FilterModuleNameBuffer member is not guaranteed to be NULL-terminated. The USHORT value at the start of each string contains the length, in bytes, of the string. Protocol drivers should check the value of the FilterModuleNameBufferLength member before they access the buffer.

Requirements

Header

ndis.h

See Also

Reference

NDIS Protocol Driver Structures
NDIS_OBJECT_HEADER
NDIS_RESTART_ATTRIBUTES
ProtocolNetPnPEvent