WifiWakeSourceListGetElement function (wificxwakesourcelist.h)

The WifiWakeSourceListGetElement function gets a wake source from the list of wake sources for a WiFiCx net adapter.

Syntax

WIFIWAKESOURCE WifiWakeSourceListGetElement(
  const WIFI_WAKE_SOURCE_LIST *List,
  SIZE_T                      Index
);

Parameters

List

[In] A handle to a driver-allocated and initialized WIFI_WAKE_SOURCE_LIST structure.

Index

[In] The zero-based index in the list for the target WIFIWAKESOURCE object. This function must be less than the value returned by WifiWakeSourceListGetCount.

Return value

Returns the WIFIWAKESOURCE object, which represents the wake source, at the specified index in the list.

Remarks

Call WifiWakeSourceListGetCount to get the number of wake sources before calling this function.

The client driver must only call WifiWakeSourceListGetElement during a power transition, typically from its EVT_WDF_DEVICE_ARM_WAKE_FROM_SX, EVT_WDF_DEVICE_ARM_WAKE_FROM_S0, or EVT_NET_DEVICE_PREVIEW_WAKE_SOURCE callback function. Otherwise, the call results in a system bugcheck.

Requirements

See also

WIFI_WAKE_SOURCE_LIST

WifiWakeSourceListGetCount