NET_WAKE_SOURCE_LIST_INIT function (netwakesourcelist.h)

Article
02/22/2024

The NET_WAKE_SOURCE_LIST_INIT function initializes a NET_WAKE_SOURCE_LIST structure.

Syntax

void NET_WAKE_SOURCE_LIST_INIT(
  [_Out_] NET_WAKE_SOURCE_LIST *List
);

Parameters

[_Out_] List

A pointer to a driver-allocated NET_WAKE_SOURCE_LIST structure.

Return value

None

Remarks

This function zeroes out the memory for the NET_WAKE_SOURCE_LIST structure, then fills in the Size member. After calling this function, call NetDeviceGetWakeSourceList with the initialized structure to get the list of wake sources for this net adapter.

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

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

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 2004
Target Platform	Universal
Header	netwakesourcelist.h (include netadaptercx.h)
IRQL	Any level as long as target memory is resident