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を返します。それ以外の場合、メソッドは次のいずれかの値を返す可能性があります。

リターンコード	説明
STATUS_INVALID_DEVICE_REQUEST	IRQL = PASSIVE_LEVELで WdfRegistryAssignString が呼び出されませんでした。
STATUS_INVALID_PARAMETER	無効なパラメーターが指定されました。
STATUS_ACCESS_DENIED	ドライバーが、KEY_SET_VALUE アクセス権を持つレジストリキーを開けませんでした。

このメソッドは、他の NTSTATUS 値を返す場合もあります。

ドライバーが無効なオブジェクトハンドルを提供すると、バグチェックが発生します。

注釈

ValueName パラメーターで指定されている値名が既に存在する場合、WdfRegistryAssignString は値のデータを更新します。

フレームワークは、値のデータ型をREG_SZに設定します。

レジストリキーオブジェクトの詳細については、「 Framework-Based ドライバーでのレジストリの使用」を参照してください。

例

次のコード例では、文字列 "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
                                     );
}

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
最小 UMDF バージョン	2.0
Header	wdfregistry.h (Wdf.h を含む)
Library	Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI コンプライアンス規則	DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)