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。 其他傳回值包括:
傳回碼 | Description |
---|---|
|
提供的緩衝區太小而無法接收資訊。 |
|
指定的 DeviceProperty 值無效 |
|
裝置的驅動程式尚未回報裝置的屬性。 |
方法可能會傳回其他 NTSTATUS值。
如果驅動程式提供無效的物件句柄,就會發生錯誤檢查。
備註
在接收裝置屬性數據之前,驅動程式通常會呼叫 WdfDeviceQueryProperty 方法,只是為了取得所需的緩衝區大小。 對於某些屬性,當傳回所需的大小和驅動程式再次呼叫 WdfDeviceQueryProperty 時,數據大小可能會變更。 因此,驅動程式應該在迴圈內呼叫 WdfDeviceQueryProperty ,直到傳回狀態未STATUS_BUFFER_TOO_SMALL為止。
最好只有在已知且未變更所需的緩衝區大小時才使用 WdfDeviceQueryProperty ,因為在此情況下,驅動程式必須只呼叫 WdfDeviceQueryProperty 一次。 如果必要的緩衝區大小不明或不同,驅動程式應該呼叫 WdfDeviceAllocAndQueryProperty。
或者,您可以使用 WdfDeviceQueryPropertyEx 來存取透過 Unified 屬性模型公開的裝置屬性。
範例
下列程式代碼範例會取得裝置的 DevicePropertyBusTypeGuid 屬性。 此範例會呼叫 WdfDeviceQueryProperty ,而不是 WdfDeviceAllocAndQueryProperty ,因為已知 GUID 的長度。
GUID busTypeGuid;
ULONG resultLength = 0;
NTSTATUS status;
status = WdfDeviceQueryProperty(
device,
DevicePropertyBusTypeGuid,
sizeof(GUID),
(PVOID)&busTypeGuid,
&resultLength
);
規格需求
需求 | 值 |
---|---|
目標平台 | Universal |
最小 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) |