PVIDEO_HW_POWER_SET callback function (video.h)

HwVidSetPowerState sets the power state of the specified device.

Syntax

PVIDEO_HW_POWER_SET PvideoHwPowerSet;

VP_STATUS PvideoHwPowerSet(
  PVOID HwDeviceExtension,
  ULONG HwId,
  PVIDEO_POWER_MANAGEMENT VideoPowerControl
)
{...}

Parameters

HwDeviceExtension

Pointer to the miniport driver's per-adapter storage area. For more information, see Device Extensions.

HwId

Pointer to a 32-bit device ID that uniquely identifies the device for which the miniport driver should set the power state. This parameter is the value returned by the miniport driver's HwVidGetVideoChildDescriptor function. A value of DISPLAY_ADAPTER_HW_ID indicates that the miniport driver should set the power state of the adapter itself.

VideoPowerControl

Pointer to a VIDEO_POWER_MANAGEMENT structure that specifies the power state to be set.

Return value

HwVidSetPowerState should always return NO_ERROR.

Remarks

HwVidSetPowerState is a required function in a video miniport driver.

The driver should check the ID specified in HwId to determine the device on which to set the power state. The driver should then set that device's power state to the level specified in the PowerState member of the VIDEO_POWER_MANAGEMENT structure to which VideoPowerControl points.

HwVidSetPowerState should be made pageable.

Requirements

Requirement Value
Target Platform Desktop
Header video.h (include Video.h)

See also

HwVidGetPowerState

HwVidGetVideoChildDescriptor

VIDEO_POWER_MANAGEMENT