PO_FX_POWER_CONTROL_CALLBACK回调函数 (wdm.h)

  • 项目

PowerControlCallback 回调例程执行电源管理框架 (PoFx) 请求的电源控制操作。

语法

PO_FX_POWER_CONTROL_CALLBACK PoFxPowerControlCallback;

NTSTATUS PoFxPowerControlCallback(
                  PVOID DeviceContext,
  [in]            LPCGUID PowerControlCode,
  [in, optional]  PVOID InBuffer,
  [in]            SIZE_T InBufferSize,
  [out, optional] PVOID OutBuffer,
  [in]            SIZE_T OutBufferSize,
  [out, optional] PSIZE_T BytesReturned
)
{...}

参数

DeviceContext

[in] PowerControlCode

指向电源控制代码的指针。 此代码是指定所请求操作的 GUID 值。

[in, optional] InBuffer

指向包含操作输入数据的缓冲区的指针。 此缓冲区中数据的格式取决于 PowerControlCode 参数指定的电源控制代码。 InBuffer 参数是可选的，如果指定的操作不需要输入数据，则可以指定为 NULL。

[in] InBufferSize

InBuffer 参数指向的输入缓冲区的大小（以字节为单位）。 如果 InBuffer 为 NULL，则此参数为零。

[out, optional] OutBuffer

指向回调例程将操作的输出数据写入到的缓冲区的指针。 此缓冲区中数据的格式取决于 PowerControlCode 参数指定的电源控制代码。 OutBuffer 参数是可选的，如果指定的操作不生成任何输出数据，则可以指定为 NULL。

[in] OutBufferSize

OutBuffer 参数指向的输出缓冲区的大小（以字节为单位）。 如果 OutBuffer 为 NULL，则此参数为零。

[out, optional] BytesReturned

指向例程写入到 OutBuffer 指向的缓冲区的数据字节数的位置的指针。 写入的字节数必须小于或等于 OutBufferSize。 此参数是可选的，如果调用方不需要知道写入输出缓冲区的字节数，则可以指定为 NULL。

返回值

如果调用成功， PowerControlCallback 例程将返回STATUS_SUCCESS。 否则，它将返回相应的错误代码。

注解

PoFx 调用此例程以将电源控制请求直接发送到设备驱动程序。 电源控制请求类似于 IOCTL) (I/O 控制请求。 但是，与 IOCTL 不同，电源控制请求直接发送到驱动程序，设备堆栈中的其他设备驱动程序不会观察到该请求。 在 PowerControlCallback 调用期间，驱动程序会同步执行请求的操作。

此例程是可选的。 实现 PowerControlCallback 例程不需要不支持电源控制操作的设备驱动程序。

设备驱动程序可以调用 PoFxPowerControl 例程向 PoFx 发送电源控制请求。

有关电源控制请求的详细信息，请参阅 PoFxPowerControl。

示例

若要定义 PowerControlCallback 回调例程，必须首先提供一个函数声明，用于标识要定义的回调例程的类型。 Windows 为驱动程序提供一组回调函数类型。 使用回调函数类型声明函数有助于 驱动程序代码分析、 静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，并且这是编写适用于 Windows 操作系统的驱动程序的要求。

例如，若要定义名为 MyPowerControlCallback的 PowerControlCallback 回调例程，请使用PO_FX_POWER_CONTROL_CALLBACK类型，如以下代码示例所示：

PO_FX_POWER_CONTROL_CALLBACK MyPowerControlCallback;

然后，按如下所示实现回调例程：

_Use_decl_annotations_
NTSTATUS
  MyPowerControlCallback(
    PVOID Context,
    LPCGUID PowerControlCode,
    PVOID InBuffer,
    SIZE_T InBufferSize,
    PVOID OutBuffer,
    SIZE_T OutBufferSize,
    PSIZE_T BytesReturned
    )
  {
      // Function body
  }

PO_FX_POWER_CONTROL_CALLBACK函数类型在 Wdm.h 头文件中定义。 若要在运行代码分析工具时更准确地识别错误，请务必将 _Use_decl_annotations_ 注释添加到函数定义。 注释 _Use_decl_annotations_ 可确保使用应用于头文件中PO_FX_POWER_CONTROL_CALLBACK函数类型的注释。 有关函数声明要求的详细信息，请参阅 使用 WDM 驱动程序的函数角色类型声明函数。 有关 的信息 _Use_decl_annotations_，请参阅 批注函数行为。

要求

要求 值
最低受支持的客户端 从 Windows 8 开始支持。
目标平台 桌面
标头 wdm.h (包括 Wudfwdm.h)
IRQL 在 IRQL <= DISPATCH_LEVEL 调用。

另请参阅

PO_FX_DEVICE

PoFxPowerControl