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。 其他返回值包括:
返回代码 | 说明 |
---|---|
|
提供的缓冲区太小,无法接收信息。 |
|
指定的 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) |
Library | Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF) |
IRQL | APC_LEVEL |