IPortClsPower::SetIdlePowerManagement method

The SetIdlePowerManagement method provides a way for the adapter driver to opt in or opt out of idle state detection.

Syntax

NTSTATUS SetIdlePowerManagement(
  PDEVICE_OBJECT _DeviceObject,
  BOOLEAN        _bEnabled
);

Parameters

_DeviceObject

Specifies a pointer to a DEVICE_OBJECT structure that represents the functional device object of the adapter.

_bEnabled

Specifies a Boolean variable that indicates whether idle state detection is enabled or disabled.

Return value

The SetIdlePowerManagement method returns STATUS_SUCCESS if the call was successful. Otherwise, it returns the appropriate error code.

Remarks

When the bEnabled parameter is set to TRUE, it indicates that the adapter driver has enabled idle state detection. When the system determines that the adapter is idle, the adapter can be put into the sleep state to save power. If the adapter was not designed to suppress the popping sound that is normally associated with power-up, it is possible that the adapter can experience a popping effect when it comes out of the sleep state.

Requirements

   
Minimum supported client Available in Windows 7 and later versions of Windows.
Target Platform Universal
Header portcls.h (include Portcls.h)
IRQL PASSIVE_LEVEL.

See also

DEVICE_OBJECT

IPortClsPower

Immediate Idle Timeout Opt-in