OID_PM_WOL_PATTERN_LIST

As a query, overlying drivers can use the OID_PM_WOL_PATTERN_LIST OID to enumerate the wake on LAN patterns that are set on an underlying network adapter. After a successful return from the query, the InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to a list of NDIS_PM_WOL_PATTERN structures that describe the currently added WOL patterns.

Remarks

NDIS handles the query for miniport drivers. NDIS drivers can use the OID_PM_WOL_PATTERN_LIST OID to get a list of wake on LAN patterns that are set on an underlying network adapter.

For each NDIS_PM_WOL_PATTERN structure in the list, NDIS sets the NextWoLPatternOffset member to the offset from the beginning of the OID information buffer (that is, the beginning of the buffer that the InformationBuffer member of the NDIS_OID_REQUEST structure points to) to the beginning of the next NDIS_PM_WOL_PATTERN structure in the list. The offset in the NextWoLPatternOffset member of the last structure in the list is zero.

For offsets in an NDIS_PM_WOL_PATTERN structure other than NextWoLPatternOffset (for example, NameBufferOffset), NDIS provides offsets that are relative to the beginning of each NDIS_PM_WOL_PATTERN structure.

If there are no WOL patterns that are set on the network adapter, NDIS sets the DATA.QUERY_INFORMATION.BytesWritten member of the NDIS_OID_REQUEST structure to zero and returns NDIS_STATUS_SUCCESS for the request. The data within the DATA.QUERY_INFORMATION.InformationBuffer member is not modified by NDIS.

NDIS returns one of the following status codes for the request:

NDIS_STATUS_SUCCESS

The request completed successfully. The InformationBuffer contains a pointer to a list of WOL patterns, if any.

NDIS_STATUS_PENDING

The request is pending completion. The final status code and results will be passed to the OID request completion handler of the caller.

NDIS_STATUS_BUFFER_TOO_SHORT

The information buffer was too short. NDIS set the DATA.QUERY_INFORMATION.BytesNeeded member in the NDIS_OID_REQUEST structure to the minimum buffer size that is required.

NDIS_STATUS_FAILURE

The request failed for reasons other than the preceding reasons.

Requirements

Version

Supported in NDIS 6.20 and later. Not requested for miniport drivers. (See Remarks section.)

Header

Ntddndis.h (include Ndis.h)

See also

NDIS_OID_REQUEST
NDIS_PM_WOL_PATTERN
OID_PM_ADD_WOL_PATTERN
OID_PM_REMOVE_WOL_PATTERN
OID_PNP_WAKE_UP_PATTERN_LIST

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft