NDIS_PM_WAKE_PACKET structure (ntddndis.h)
The NDIS_PM_WAKE_PACKET structure describes a network packet (known as a wake packet) that caused the network adapter to generate a wake-up event.
typedef struct _NDIS_PM_WAKE_PACKET {
NDIS_OBJECT_HEADER Header;
ULONG Flags;
ULONG PatternId;
NDIS_PM_COUNTED_STRING PatternFriendlyName;
ULONG OriginalPacketSize;
ULONG SavedPacketSize;
ULONG SavedPacketOffset;
} NDIS_PM_WAKE_PACKET, *PNDIS_PM_WAKE_PACKET;
Header
The type, revision, and size of the NDIS_PM_WAKE_PACKET 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_DEFAULT. To specify the version of the NDIS_PM_WAKE_PACKET structure, the driver must set the Revision member of Header to the following value:
Original version for NDIS 6.30 and later.
Set the Size member to NDIS_SIZEOF_PM_WAKE_PACKET_REVISION_1.
Flags
A ULONG value that contains a bitwise OR of flags. This member is reserved for NDIS.
PatternId
A ULONG value that specifies the identifier of the wake-on-LAN (WOL) pattern that matches the wake packet. This identifier is specified by the PatternId member of the NDIS_PM_WOL_PATTERN structure that is passed to the driver during an OID set request of OID_PM_ADD_WOL_PATTERN.
PatternFriendlyName
An NDIS_PM_COUNTED_STRING value that contains the friendly description of the wake pattern that is specified by the PatternId member. This value is specified by the FriendlyName member of the NDIS_PM_WOL_PATTERN structure that is passed to the driver during an OID request of OID_PM_ADD_WOL_PATTERN.
OriginalPacketSize
A ULONG value that specifies the original length, in units of bytes, of the wake packet.
SavedPacketSize
A ULONG value that specifies the length, in units of bytes, of the wake packet data that follows this structure.
min(wake packet size, 128)
bytes.SavedPacketOffset
A ULONG value that specifies the offset, in units of bytes, to the wake packet data that follows this structure. The offset is measured from the start of the NDIS_PM_WAKE_PACKET structure to the beginning of a buffer that contains the wake packet.
The NDIS_PM_WAKE_PACKET structure is used in the NDIS_STATUS_PM_WAKE_REASON status indication. For more information about how to issue this status indication, see Issuing NDIS Wake Reason Status Indications.
Requirement | Value |
---|---|
Minimum supported client | Supported in NDIS 6.30 and later. |
Header | ntddndis.h (include Ndis.h) |