wdfRegistryQueryValue 函式 (wdfregistry.h)

發行項
02/29/2024

[適用於 KMDF 和 UMDF]

WdfRegistryQueryValue 方法會擷取目前指派給指定登錄值的數據。

語法

NTSTATUS WdfRegistryQueryValue(
  [in]            WDFKEY           Key,
  [in]            PCUNICODE_STRING ValueName,
  [in]            ULONG            ValueLength,
  [out, optional] PVOID            Value,
  [out, optional] PULONG           ValueLengthQueried,
  [out, optional] PULONG           ValueType
);

參數

[in] Key

代表已開啟登錄機碼之登錄機碼物件的句柄。

[in] ValueName

包含值名稱之UNICODE_STRING 結構的指標。

[in] ValueLength

Value 所指向緩衝區的長度，以位元組為單位。

[out, optional] Value

驅動程式配置的緩衝區指標，可接收登錄值的數據。如果這個指標是 NULL，WdfRegistryQueryValue 會擷取數據長度，但不會擷取數據。

[out, optional] ValueLengthQueried

接收登錄值數據長度之位置的指標。此指標是選擇性的，而且可以是 NULL。

[out, optional] ValueType

接收登錄值數據類型之位置的指標。如需數據類型值的清單，請參閱 KEY_VALUE_BASIC_INFORMATION的 Type 成員。此指標是選擇性的，而且可以是 NULL。

傳回值

如果作業成功，WdfRegistryQueryValue 會傳回STATUS_SUCCESS。否則，方法可能會傳回下列其中一個值：

傳回碼	Description
STATUS_INVALID_DEVICE_REQUEST	在 IRQL = PASSIVE_LEVEL 未呼叫 WdfRegistryQueryValue。
STATUS_INVALID_PARAMETER	指定了無效的參數。
STATUS_ACCESS_DENIED	驅動程式未使用KEY_QUERY_VALUE、KEY_READ或KEY_ALL_ACCESS存取來開啟登錄機碼。
STATUS_BUFFER_OVERFLOW	Value 參數指向的緩衝區太小，而且只有部分數據已寫入緩衝區。
STATUS_BUFFER_OVERFLOW	值緩衝區太小，而且沒有任何數據寫入緩衝區。
STATUS_OBJECT_NAME_NOT_FOUND	登錄值無法使用。

這個方法也可能傳回其他 NTSTATUS值。

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

備註

如需登錄機碼對象的詳細資訊，請參閱在 Framework-Based Drivers 中使用登錄。

範例

下列程式代碼範例會開啟裝置的硬體密鑰，並擷取指派給 NumberOfToasters 值的數據，其儲存在裝置的硬體密鑰之下。

WCHAR  comPort[FM_COM_PORT_STRING_LENGTH];
ULONG  length;
NTSTATUS  status;
ULONG  length, valueType, value;
DECLARE_CONST_UNICODE_STRING(valueName, L"NumberOfToasters");
WDFKEY  hKey;

status = WdfDeviceOpenRegistryKey(
                                  Device,
                                  PLUGPLAY_REGKEY_DEVICE,
                                  KEY_QUERY_VALUE,
                                  NULL, 
                                  &hKey
                                  );
if (!NT_SUCCESS (status)) {
    goto Error;
}
status = WdfRegistryQueryValue(
                               hKey,
                               &valueName,
                               sizeof(ULONG),
                               &value,
                               &length,
                               &valueType
                               );

規格需求

需求	值
目標平台	Universal
最低 KMDF 版本	1.0
最低UMDF版本	2.0
標頭	wdfregistry.h (包含 Wdf.h)
程式庫	Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI 合規性規則	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)