WdfRegistryQueryUnicodeString 関数 (wdfregistry.h)

[アーティクル]
08/08/2023

[KMDF と UMDF に適用]

WdfRegistryQueryUnicodeString メソッドは、指定されたレジストリ文字列値に現在割り当てられている文字列データを取得し、指定したUNICODE_STRING構造体に文字列をコピーします。

構文

NTSTATUS WdfRegistryQueryUnicodeString(
  [in]            WDFKEY           Key,
  [in]            PCUNICODE_STRING ValueName,
  [out, optional] PUSHORT          ValueByteLength,
  [in, out]       PUNICODE_STRING  Value
);

パラメーター

[in] Key

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

[in] ValueName

レジストリ値の名前を含む UNICODE_STRING 構造体へのポインター。

[out, optional] ValueByteLength

Value が指す Unicode 文字列に含まれるバイト数 (終端の NULL バイトを含む) を受け取る場所へのポインター。このポインターは省略可能であり、NULL にすることができます

[in, out] Value

Key が指定するキーのデータ文字列を受け取るUNICODE_STRING構造体へのポインター。このパラメーターが NULL で 、ValueByteLength が NULL 以外の場合、 WdfRegistryQueryUnicodeString は文字列のサイズのみを返します。

戻り値

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

リターンコード	説明
STATUS_INVALID_DEVICE_REQUEST	IRQL = PASSIVE_LEVELで WdfRegistryQueryUnicodeString が呼び出されませんでした。
STATUS_INVALID_PARAMETER	無効なパラメーターが指定されました。
STATUS_INSUFFICIENT_RESOURCES	操作を完了するためのメモリが不足していました。
STATUS_ACCESS_DENIED	ドライバーは、KEY_QUERY_VALUE、KEY_READ、またはKEY_ALL_ACCESSアクセスでレジストリキーを開けませんでした。
STATUS_OBJECT_TYPE_MISMATCH	ValueName パラメーターが指定したレジストリ値のデータ型がREG_SZされませんでした。
STATUS_BUFFER_OVERFLOW	Value パラメーターが指すバッファーが小さすぎて、部分的なデータのみがバッファーに書き込まれた。
STATUS_BUFFER_OVERFLOW	Value パラメーターが指すバッファーが小さすぎて、バッファーにデータが書き込まれなかった。
STATUS_OBJECT_NAME_NOT_FOUND	レジストリ値が使用できませんでした。

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

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

注釈

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

例

シリアルサンプルドライバーの次のコード例では、デバイスのハードウェアキーの 下の PortName 値に割り当てられている文字列データを表す Unicode 文字列を取得します。

NTSTATUS
SerialReadSymName(
    IN WDFDEVICE Device,
    __out PWCHAR RegName,
    IN OUT PUSHORT LengthOfRegName // In characters
    )
{
    NTSTATUS status;
    WDFKEY hKey;
    UNICODE_STRING value;
    UNICODE_STRING valueName;
    USHORT requiredLength;

    value.Buffer = RegName;
    value.MaximumLength = *LengthOfRegName;
    value.Length = 0;

    status = WdfDeviceOpenRegistryKey(
                                      Device,
                                      PLUGPLAY_REGKEY_DEVICE,
                                      STANDARD_RIGHTS_ALL,
                                      WDF_NO_OBJECT_ATTRIBUTES,
                                      &hKey
                                      );

    if (NT_SUCCESS (status)) {
        RtlInitUnicodeString(
                             &valueName,
                             L"PortName"
                             );
        status = WdfRegistryQueryUnicodeString (
                                      hKey,
                                      &valueName,
                                      &requiredLength,
                                      &value
                                      );
        WdfRegistryClose(hKey);
    }
    return status;
}

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 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)