WdfDeviceQueryInterfaceProperty 函数 (wdfdevice.h)
[仅适用于 UMDF]
WdfDeviceQueryInterfaceProperty 方法检索指定的设备接口属性。
语法
NTSTATUS WdfDeviceQueryInterfaceProperty(
[in] WDFDEVICE Device,
[in] PWDF_DEVICE_INTERFACE_PROPERTY_DATA PropertyData,
[in] ULONG BufferLength,
[out] PVOID PropertyBuffer,
[out] PULONG ResultLength,
[out] PDEVPROPTYPE Type
);
参数
[in] Device
框架设备对象的句柄。
[in] PropertyData
指向 WDF_DEVICE_INTERFACE_PROPERTY_DATA 结构的指针,该结构标识要检索的设备接口属性。
[in] BufferLength
PropertyBuffer 指向的缓冲区的大小(以字节为单位)。
[out] PropertyBuffer
指向调用方分配的缓冲区的指针,该缓冲区接收请求的设备接口属性。 如果 BufferLength 参数为零,则指针可以为 NULL。
[out] ResultLength
调用方提供的位置,返回时包含存储在 PropertyBuffer 中的 WdfDeviceQueryInterfaceProperty 的信息的大小(以字节为单位)。 如果函数的返回值为 STATUS_BUFFER_TOO_SMALL,则此位置接收所需的缓冲区大小。
[out] Type
指向 DEVPROPTYPE 类型变量的指针,该变量标识 WdfDeviceQueryInterfaceProperty 存储在 PropertyBuffer 指向的缓冲区中的属性数据类型。
返回值
如果 WdfDeviceQueryInterfaceProperty 方法未遇到任何错误,则返回STATUS_SUCCESS。 其他返回值包括:
返回代码 | 说明 |
---|---|
|
输入缓冲区太小,无法接收信息。 |
|
指定的参数值无效。 |
方法可能会返回其他 NTSTATUS 值。
注解
在接收设备属性数据之前,驱动程序通常调用 WdfDeviceQueryInterfaceProperty 方法来获取所需的缓冲区大小。 对于某些属性,数据大小可以在返回所需大小和驱动程序再次调用 WdfDeviceQueryInterfaceProperty 之间更改。 因此,驱动程序应在循环中调用 WdfDeviceQueryInterfaceProperty ,该循环将一直执行,直到返回状态不STATUS_BUFFER_TOO_SMALL。
最好仅在所需的缓冲区大小已知且不变时才使用 WdfDeviceQueryInterfaceProperty ,因为在这种情况下,驱动程序只需调用 一次 WdfDeviceQueryInterfaceProperty 。 如果所需的缓冲区大小未知或变化,驱动程序应调用 WdfDeviceAllocAndQueryInterfaceProperty。
有关相关方法的信息,请参阅 访问统一设备属性模型。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 8.1 |
目标平台 | 通用 |
最低 UMDF 版本 | 2.0 |
标头 | wdfdevice.h (包括 Wdf.h) |
Library | WUDFx02000.lib |
DLL | WUDFx02000.dll |
IRQL | PASSIVE_LEVEL |
另请参阅
WDF_DEVICE_INTERFACE_PROPERTY_DATA
WDF_DEVICE_INTERFACE_PROPERTY_DATA_INIT