WdfRegistryQueryString 函式 (wdfregistry.h)

發行項
02/29/2024

[適用於 KMDF 和 UMDF]

WdfRegistryQueryString 方法會擷取目前指派給指定登錄字串值的字串數據，並將字串指派給指定的架構字串物件。

語法

NTSTATUS WdfRegistryQueryString(
  [in] WDFKEY           Key,
  [in] PCUNICODE_STRING ValueName,
  [in] WDFSTRING        String
);

參數

[in] Key

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

[in] ValueName

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

[in] String

架構字串物件的句柄。架構會將登錄值的字串數據指派給這個物件。

傳回值

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

傳回碼	Description
STATUS_INVALID_DEVICE_REQUEST	未在 IRQL = PASSIVE_LEVEL呼叫 WdfRegistryQueryString。
STATUS_INVALID_PARAMETER	指定了無效的參數。
STATUS_INSUFFICIENT_RESOURCES	記憶體不足，無法完成作業。
STATUS_ACCESS_DENIED	驅動程式未使用KEY_QUERY_VALUE、KEY_READ或KEY_ALL_ACCESS存取來開啟登錄機碼。
STATUS_OBJECT_TYPE_MISMATCH	未REG_SZ指定 ValueName 參數之登錄值的數據類型。
STATUS_OBJECT_NAME_NOT_FOUND	登錄值無法使用。
STATUS_RESOURCE_DATA_NOT_FOUND	登錄值存在於指定的機碼底下，但是空的。

如需 WdfRegistryQueryString 方法可能會傳回的其他傳回值清單，請參閱 Framework 物件建立錯誤。

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

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

備註

若要從字串物件取得字串，您的驅動程式可以呼叫 WdfStringGetUnicodeString。

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

範例

下列程式代碼範例會建立字串物件、從登錄機碼擷取字串數據，並從字串物件取得字串數據。

UNICODE_STRING str;
WDFSTRING string;
NTSTATUS status;
DECLARE_CONST_UNICODE_STRING(valueName, STRING_VALUE_NAME);

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfRegistryQueryString(
                                    Key, 
                                    &valueName,
                                    string
                                    );
    if (NT_SUCCESS(status)) {
        WdfStringGetUnicodeString(
                                  string,
                                  &str
                                  );
    }
}

規格需求

需求	值
目標平台	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)