WdfDeviceQueryPropertyEx 函数 (wdfdevice.h)

[适用于 KMDF 和 UMDF]

WdfDeviceQueryPropertyEx 方法检索指定的设备属性。

语法

NTSTATUS WdfDeviceQueryPropertyEx(
  [in]  WDFDEVICE                 Device,
  [in]  PWDF_DEVICE_PROPERTY_DATA DeviceProperty,
  [in]  ULONG                     BufferLength,
  [out] PVOID                     PropertyBuffer,
  [out] PULONG                    RequiredSize,
  [out] PDEVPROPTYPE              Type
);

参数

[in] Device

框架设备对象的句柄。

[in] DeviceProperty

指向 WDF_DEVICE_PROPERTY_DATA 结构的指针,用于标识要检索的设备属性。

[in] BufferLength

PropertyBuffer指向的缓冲区的大小(以字节为单位)。

[out] PropertyBuffer

调用方提供的指向调用方分配的缓冲区的指针,该缓冲区接收请求的信息。 如果 BufferLength 参数为零,则可以 NULL 指针。

[out] RequiredSize

调用方提供的位置,返回时包含存储在 propertyBuffer 中的方法的信息的大小(以字节为单位)。 如果函数的返回值 STATUS_BUFFER_TOO_SMALL,则此位置会收到所需的缓冲区大小。

[out] Type

指向 DEVPROPTYPE 变量的指针。 如果方法成功,则返回此参数时包含存储在 propertyBuffer 中的属性数据的属性值。

返回值

如果作成功,WdfDeviceQueryPropertyEx 返回STATUS_SUCCESS。 其他返回值包括:

返回代码 描述
STATUS_BUFFER_TOO_SMALL
提供的缓冲区太小,无法接收信息。
STATUS_INVALID_PARAMETER
指定的 DeviceProperty 值无效。
 

此方法可能会返回其他 NTSTATUS 值

如果驱动程序提供无效的对象句柄,则会发生 bug 检查。

言论

可以使用 WdfDeviceQueryPropertyEx 检索通过统一属性模型公开的任何属性,而 WdfDeviceQueryProperty 方法仅允许查询统一属性模型的子集。

在接收设备属性数据之前,驱动程序通常会调用 WdfDeviceQueryPropertyEx 方法,以获取所需的缓冲区大小。 对于某些属性,数据大小可以在返回所需大小和驱动程序再次调用 WdfDeviceQueryPropertyEx 之间更改。 因此,驱动程序应在一个循环中调用 WdfDeviceQueryPropertyEx,直到返回状态未STATUS_BUFFER_TOO_SMALL。

最好仅在所需的缓冲区大小已知且未更改时才使用 WdfDeviceQueryPropertyEx,因为在这种情况下,驱动程序必须仅调用 WdfDeviceQueryPropertyEx 一次。 如果所需的缓冲区大小未知或不同,驱动程序应调用 WdfDeviceAllocAndQueryPropertyEx

有关相关方法的信息,请参阅 访问统一设备属性模型

要求

要求 价值
目标平台 普遍
最低 KMDF 版本 1.13
最低 UMDF 版本 2.0
标头 wdfdevice.h (包括 Wdf.h)
Wdf01000.sys(KMDF):WUDFx02000.dll (UMDF)
IRQL APC_LEVEL

另请参阅

WdfDeviceQueryInterfaceProperty

WdfDeviceQueryProperty