NetPowerOffloadListGetElement function (netpoweroffloadlist.h)

Article
02/22/2024

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

Syntax

NETPOWEROFFLOAD NetPowerOffloadListGetElement(
  [_In_] const NET_POWER_OFFLOAD_LIST *List,
  [_In_] SIZE_T                       Index
);

Parameters

[_In_] List

A pointer to a driver-allocated and initialized NET_POWER_OFFLOAD_LIST structure.

[_In_] Index

The zero-based index in the list for the target NETPOWEROFFLOAD object. This function must be less than the value returned by NetPowerOffloadListGetCount.

Return value

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

Remarks

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

The client driver must only call NetPowerOffloadListGetElement 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.

For a code sample of working with NETPOWEROFFLOAD objects, see Configuring power management.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 2004
Target Platform	Universal
Header	netpoweroffloadlist.h (include netadaptercx.h)
IRQL	PASSIVE_LEVEL