WdfRegistryAssignString 函式 (wdfregistry.h)

發行項
02/27/2024

[適用於 KMDF 和 UMDF]

WdfRegistryAssignString 方法會將字串指派給登錄中的指定值名稱。字串包含在指定的架構字串物件中。

語法

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

參數

[in] Key

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

[in] ValueName

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

[in] String

包含字串的架構字串物件的句柄。

傳回值

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

傳回碼	Description
STATUS_INVALID_DEVICE_REQUEST	在 IRQL = PASSIVE_LEVEL未呼叫 WdfRegistryAssignString。
STATUS_INVALID_PARAMETER	指定了無效的參數。
STATUS_ACCESS_DENIED	驅動程式未開啟具有KEY_SET_VALUE存取權的登錄機碼。

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

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

備註

如果 ValueName 參數指定的值名稱已經存在， WdfRegistryAssignString 會更新值的數據。

架構會將值的數據類型設定為REG_SZ。

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

範例

下列程式代碼範例會建立字串物件，其中包含字串「String1」，並將字串指派給指定登錄機碼下的 ValueName 值。

WDFSTRING string1;
UNICODE_STRING ustring1, valueName;
NTSTATUS status;

RtlInitUnicodeString(
                     &ustring1,
                     L"String1"
                     );
RtlInitUnicodeString(
                     &valueName,
                     L"ValueName"
                     );

status = WdfStringCreate(
                         &ustring1,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string1
                         );
if (NT_SUCCESS(status)) {
    status = WdfRegistryAssignString(
                                     Key,
                                     &valueName,
                                     string1
                                     );
}

規格需求

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