NetWakeSourceGetBitmapParameters function (netwakesource.h)

Article
02/22/2024

The NetWakeSourceGetBitmapParameters function gets parameters for a bitmap pattern wake-on-LAN (WoL) source.

Syntax

void NetWakeSourceGetBitmapParameters(
  [_In_]    NETWAKESOURCE                     WakeSource,
  [_Inout_] NET_WAKE_SOURCE_BITMAP_PARAMETERS *Parameters
);

Parameters

[_In_] WakeSource

A NETWAKESOURCE object that represents this bitmap pattern wake source.

[_Inout_] Parameters

A pointer to a driver-allocated and initialized NET_WAKE_SOURCE_BITMAP_PARAMETERS structure that receives the bitmap pattern parameters.

Return value

None

Remarks

Call NET_WAKE_SOURCE_BITMAP_PARAMETERS_INIT to initialize the NET_WAKE_SOURCE_BITMAP_PARAMETERS structure before calling this function.

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

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