NetPowerSettingsGetEnabledProtocolOffloadFlags function

Warning

Some information in this topic relates to prereleased product, which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

NetAdapterCx is preview only in Windows 10, version 1903.

Retrieves flags that specify currently enabled low power protocol offloads that a network adapter supports.

Syntax

ULONG NetPowerSettingsGetEnabledProtocolOffloadFlags(
  NETPOWERSETTINGS NetPowerSettings
);

Parameters

NetPowerSettings

A handle to the NETPOWERSETTINGS object associated with the net adapter. To retrieve the handle, call NetAdapterGetPowerSettings.

Return Value

A ULONG value that contains a bitwise OR of NET_ADAPTER_PROTOCOL_OFFLOADS_FLAGS-typed flags that correspond to events that the client driver reported in the SupportedProtocolOffloads member of the NET_ADAPTER_POWER_CAPABILITIES structure. NDIS uses these flags to enable the low power protocol offload capabilities on a network adapter.

For more information, see NDIS_PM_PARAMETERS.

Remarks

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

Requirements

   
Target Platform Universal
Minimum KMDF version 1.23
Header netpowersettings.h (include netadaptercx.h)
Library NetAdapterCxStub.lib
IRQL PASSIVE_LEVEL