WdfRegistryQueryValue 関数 (wdfregistry.h)

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

[KMDF と UMDF に適用]

WdfRegistryQueryValue メソッドは、指定されたレジストリ値に現在割り当てられているデータを取得します。

構文

NTSTATUS WdfRegistryQueryValue(
  [in]            WDFKEY           Key,
  [in]            PCUNICODE_STRING ValueName,
  [in]            ULONG            ValueLength,
  [out, optional] PVOID            Value,
  [out, optional] PULONG           ValueLengthQueried,
  [out, optional] PULONG           ValueType
);

パラメーター

[in] Key

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

[in] ValueName

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

[in] ValueLength

Value が指すバッファーの長さ (バイト単位)。

[out, optional] Value

レジストリ値のデータを受け取るドライバーによって割り当てられたバッファーへのポインター。このポインターが NULL の場合、 WdfRegistryQueryValue はデータの長さを取得しますが、データは取得しません。

[out, optional] ValueLengthQueried

レジストリ値のデータ長を受け取る場所へのポインター。このポインターは省略可能であり、 NULL にすることができます。

[out, optional] ValueType

レジストリ値のデータ型を受け取る場所へのポインター。データ型の値の一覧については、KEY_VALUE_BASIC_INFORMATIONの Type メンバーを参照してください。このポインターは省略可能であり、 NULL にすることができます。

戻り値

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

リターンコード	説明
STATUS_INVALID_DEVICE_REQUEST	IRQL = PASSIVE_LEVEL で WdfRegistryQueryValue が呼び出されませんでした。
STATUS_INVALID_PARAMETER	無効なパラメーターが指定されました。
STATUS_ACCESS_DENIED	ドライバーが、KEY_QUERY_VALUE、KEY_READ、またはKEY_ALL_ACCESSアクセス権を持つレジストリキーを開けませんでした。
STATUS_BUFFER_OVERFLOW	Value パラメーターが指すバッファーが小さすぎて、部分的なデータのみがバッファーに書き込まれた。
STATUS_BUFFER_OVERFLOW	値バッファーが小さすぎて、バッファーにデータが書き込まれなくなりました。
STATUS_OBJECT_NAME_NOT_FOUND	レジストリ値が使用できませんでした。

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

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

注釈

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

例

次のコード例では、デバイスのハードウェアキーを開き、デバイスのハードウェアキーの下に格納されている NumberOfToasters 値に割り当てられたデータを取得します。

WCHAR  comPort[FM_COM_PORT_STRING_LENGTH];
ULONG  length;
NTSTATUS  status;
ULONG  length, valueType, value;
DECLARE_CONST_UNICODE_STRING(valueName, L"NumberOfToasters");
WDFKEY  hKey;

status = WdfDeviceOpenRegistryKey(
                                  Device,
                                  PLUGPLAY_REGKEY_DEVICE,
                                  KEY_QUERY_VALUE,
                                  NULL, 
                                  &hKey
                                  );
if (!NT_SUCCESS (status)) {
    goto Error;
}
status = WdfRegistryQueryValue(
                               hKey,
                               &valueName,
                               sizeof(ULONG),
                               &value,
                               &length,
                               &valueType
                               );

要件

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