NDIS_MINIPORT_SS_CHARACTERISTICS structure (ndis.h)

The NDIS_MINIPORT_SS_CHARACTERISTICS structure specifies the pointers to a miniport driver's NDIS selective suspend handler functions. These functions are called by NDIS to issue idle notifications to the driver during a selective suspend operation.

Syntax

typedef struct _NDIS_MINIPORT_SS_CHARACTERISTICS {
  NDIS_OBJECT_HEADER                        Header;
  ULONG                                     Flags;
  MINIPORT_IDLE_NOTIFICATION_HANDLER        IdleNotificationHandler;
  MINIPORT_CANCEL_IDLE_NOTIFICATION_HANDLER CancelIdleNotificationHandler;
} NDIS_MINIPORT_SS_CHARACTERISTICS, *PNDIS_MINIPORT_SS_CHARACTERISTICS;

Members

Header

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

The miniport driver must set the Type member of Header to NDIS_OBJECT_TYPE_MINIPORT_SS_CHARACTERISTICS. To specify the version of the NDIS_MINIPORT_SS_CHARACTERISTICS structure, the driver must set the Revision member of Header to the following value:

NDIS_MINIPORT_SS_CHARACTERISTICS_REVISION_1

Original version for NDIS 6.30 and later.

Set the Size member to NDIS_SIZEOF_MINIPORT_SS_CHARACTERISTICS_REVISION_1.

Flags

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

IdleNotificationHandler

A pointer to the miniport driver's MiniportIdleNotification function.

CancelIdleNotificationHandler

A pointer to the miniport driver's MiniportCancelIdleNotification function.

Remarks

To register the handler functions for NDIS selective suspend, the miniport driver follows these steps when its MiniportSetOptions function is called:

1. The miniport driver initializes an NDIS_MINIPORT_SS_CHARACTERISTICS structure with pointers to the handler functions.
2. The miniport driver then calls NdisSetOptionalHandlers and sets the OptionalHandlers parameter to a pointer to the NDIS_MINIPORT_SS_CHARACTERISTICS structure.

Requirements

See also

MiniportCancelIdleNotification

MiniportIdleNotification

MiniportSetOptions

NDIS_OBJECT_HEADER

NdisSetOptionalHandlers