WdfDeviceQueryProperty 函数 (wdfdevice.h)
[适用于 KMDF 和 UMDF]
WdfDeviceQueryProperty 方法检索指定的设备属性。
语法
NTSTATUS WdfDeviceQueryProperty(
[in] WDFDEVICE Device,
[in] DEVICE_REGISTRY_PROPERTY DeviceProperty,
[in] ULONG BufferLength,
[out] PVOID PropertyBuffer,
[out] PULONG ResultLength
);
参数
[in] Device
框架设备对象的句柄。
[in] DeviceProperty
标识要检索的设备属性的 DEVICE_REGISTRY_PROPERTY类型枚举器。
[in] BufferLength
PropertyBuffer指向的缓冲区的大小(以字节为单位)。
[out] PropertyBuffer
调用方提供的指向调用方分配的缓冲区的指针,该缓冲区接收请求的信息。 如果 BufferLength 参数为零,则可以 NULL 指针。
[out] ResultLength
调用方提供的位置,返回时包含存储在 propertyBuffer 中的方法的信息的大小(以字节为单位)。 如果函数的返回值STATUS_BUFFER_TOO_SMALL,则此位置会收到所需的缓冲区大小。
返回值
如果作成功,WdfDeviceQueryProperty 返回STATUS_SUCCESS。 其他返回值包括:
返回代码 | 描述 |
---|---|
|
提供的缓冲区太小,无法接收信息。 |
|
指定的 DeviceProperty 值无效 |
|
设备的驱动程序尚未报告设备的属性。 |
此方法可能会返回其他 NTSTATUS 值。
如果驱动程序提供无效的对象句柄,则会发生 bug 检查。
言论
在接收设备属性数据之前,驱动程序通常会调用 WdfDeviceQueryProperty 方法,以获取所需的缓冲区大小。 对于某些属性,数据大小可以在返回所需大小和驱动程序再次调用 WdfDeviceQueryProperty 之间更改。 因此,驱动程序应调用 WdfDeviceQueryProperty 执行循环,直到返回状态未STATUS_BUFFER_TOO_SMALL。
最好仅在所需的缓冲区大小已知且未更改的情况下使用 WdfDeviceQueryProperty,因为在这种情况下,驱动程序必须仅调用 WdfDeviceQueryProperty 一次。 如果所需的缓冲区大小未知或不同,驱动程序应调用 WdfDeviceAllocAndQueryProperty。
或者,可以使用 WdfDeviceQueryPropertyEx 访问通过统一属性模型公开的设备属性。
例子
下面的代码示例获取设备的 DevicePropertyBusTypeGuid 属性。 该示例调用 WdfDeviceQueryProperty,而不是 WdfDeviceAllocAndQueryProperty,因为 GUID 的长度已知。
GUID busTypeGuid;
ULONG resultLength = 0;
NTSTATUS status;
status = WdfDeviceQueryProperty(
device,
DevicePropertyBusTypeGuid,
sizeof(GUID),
(PVOID)&busTypeGuid,
&resultLength
);
要求
要求 | 价值 |
---|---|
目标平台 | 普遍 |
最低 KMDF 版本 | 1.0 |
最低 UMDF 版本 | 2.0 |
标头 | wdfdevice.h (包括 Wdf.h) |
库 | Wdf01000.sys(KMDF):WUDFx02000.dll (UMDF) |
IRQL | PASSIVE_LEVEL |
DDI 符合性规则 | DriverCreate(kmdf),KmdfIrql(kmdf),KmdfIrql2(kmdf),KmdfIrqlExplicit(kmdf) |