WdfRegistryAssignUnicodeString 関数 (wdfregistry.h)

[アーティクル]
02/29/2024

[KMDF と UMDF に適用]

WdfRegistryAssignUnicodeString メソッドは、指定した Unicode 文字列をレジストリ内の指定された値名に割り当てます。

構文

NTSTATUS WdfRegistryAssignUnicodeString(
  [in] WDFKEY           Key,
  [in] PCUNICODE_STRING ValueName,
  [in] PCUNICODE_STRING Value
);

パラメーター

[in] Key

開かれたレジストリキーを表すレジストリキーオブジェクトへのハンドル。

[in] ValueName

値名を含む UNICODE_STRING 構造体へのポインター。

[in] Value

ValueName が指定する値名に割り当てられる文字列を含むUNICODE_STRING構造体へのポインター。

戻り値

操作が成功した場合、WdfRegistryAssignUnicodeString はSTATUS_SUCCESSを返します。それ以外の場合、メソッドは次のいずれかの値を返す可能性があります。

リターンコード	説明
STATUS_INVALID_DEVICE_REQUEST	WdfRegistryAssignUnicodeString は IRQL = PASSIVE_LEVELで呼び出されませんでした。
STATUS_INVALID_PARAMETER	無効なパラメーターが指定されました。
STATUS_ACCESS_DENIED	ドライバーが、KEY_SET_VALUE アクセス権を持つレジストリキーを開けませんでした。
STATUS_INSUFFICIENT_RESOURCES	操作を完了するためのメモリが不足していました。

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

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

注釈

Value パラメーターが指定する文字列が NULL で終了しない場合、フレームワークは、文字列をレジストリにコピーするときに NULL 文字を追加します。

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

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

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

例

次のコード例では、指定したレジストリキーの下で、Unicode 文字列 "String1" を ValueName 値に割り当てます。

UNICODE_STRING ustring1, valueName;
NTSTATUS status;

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

status = WdfRegistryAssignUnicodeString(
                                        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)