WifiPowerOffloadListGetElement function (wificxpoweroffloadlist.h)

The WifiPowerOffloadListGetElement function gets a low power protocol offload from a list of offloads to a WiFiCx net adapter.

Syntax

WIFIPOWEROFFLOAD WifiPowerOffloadListGetElement(
  const WIFI_POWER_OFFLOAD_LIST *List,
  SIZE_T                        Index
);

Parameters

List

[In] A pointer to a driver-allocated and initialized WIFI_POWER_OFFLOAD_LIST structure.

Index

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

Return value

Returns the WIFIPOWEROFFLOAD object, which represents the low power protocol offload, at the specified index in the list.

Remarks

Call WifiPowerOffloadListGetCount to get the number of low power protocol offloads before calling this function.

The client driver must only call WifiPowerOffloadListGetElement 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_POWER_OFFLOAD callback function. Otherwise, the call results in a system bugcheck.

Requirements

See also

WIFI_POWER_OFFLOAD_LIST

WifiPowerOffloadListGetCount