IRegistryKey::QueryValueKey メソッド (portcls.h)

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

メソッドは QueryValueKey 、レジストリキーの値エントリに関する情報 (名前、型、データサイズ、値など) を取得します。

構文

NTSTATUS QueryValueKey(
  [in]  PUNICODE_STRING             ValueName,
  [in]  KEY_VALUE_INFORMATION_CLASS KeyValueInformationClass,
  [out] PVOID                       KeyValueInformation,
  [in]  ULONG                       Length,
  [out] PULONG                      ResultLength
);

パラメーター

[in] ValueName

値エントリの製造元が指定した名前へのポインター。名前文字列は、 UNICODE_STRING型の構造体によって指定されます。

[in] KeyValueInformationClass

バッファーに返される情報の種類を指定します。このパラメーターを、次のいずれかのKEY_VALUE_INFORMATION_CLASS列挙値に設定します。

KeyValueBasicInformation
KeyValueFullInformation
KeyValuePartialInformation

[out] KeyValueInformation

メソッドが要求されたデータを書き込む呼び出し元によって割り当てられたバッファーへのポインター。バッファーには、KeyValueInformationClass の値に応じて、KEY_VALUE_BASIC_INFORMATION型、KEY_VALUE_FULL_INFORMATION型、またはKEY_VALUE_PARTIAL_INFORMATION型の構造体が含まれています。構造体の後に、キー値のデータ型に依存するサイズの追加データが続きます。

[in] Length

指定された KeyValueInformationClass に従って呼び出し元が設定する必要がある KeyValueInformation バッファーのサイズ (バイト単位)。要求されたすべてのデータを受信するには、バッファーが少なくとも要求されたデータのサイズと同じ大きさである必要があります。

[out] ResultLength

結果のデータの長さの出力ポインター。このパラメーターは、呼び出し元によって割り当てられた ULONG 変数を指します。この変数は、 KeyValueInformation バッファーに実際に書き込まれたバイト数を指定するカウントをメソッドが書き込みます。ただし、指定したバッファー長が小さすぎて情報を格納できません。ただし、メソッドは代わりに必要なバッファーサイズを出力し、STATUS_BUFFER_OVERFLOWまたはSTATUS_BUFFER_TOO_SMALLを返します。詳細については、「解説」を参照してください。

戻り値

QueryValueKey は、要求された情報を KeyValueInformation バッファーにコピーして呼び出しが成功した場合にSTATUS_SUCCESSを返します。指定したバッファーサイズが小さすぎて要求されたすべての情報を受け取れない場合、メソッドは STATUS_BUFFER_OVERFLOWを返します。指定したバッファーサイズが小さすぎて要求された情報を受け取れない場合、メソッドは STATUS_BUFFER_TOO_SMALLを返します。それ以外の場合、メソッドは適切なエラー状態コードを返します。次の表に、考えられるエラーコードの一部を示します。

リターンコード	説明
STATUS_INVALID_PARAMETER	メソッドに渡されるパラメーターの 1 つが無効であることを示します。
STATUS_OBJECT_NAME_NOT_FOUND	指定した名前の値エントリが見つからなかったことを示します。

注釈

KeyValueInformation バッファーが小さすぎて要求された情報を保持できない場合、メソッドは必要なサイズを *ResultLength に書き込み、STATUS_BUFFER_OVERFLOWまたはSTATUS_BUFFER_TOO_SMALLのいずれかの状態コードを返します。メソッドは、要求された情報の一部のみをバッファーに書き込むのに成功した場合、STATUS_BUFFER_OVERFLOWを返します。バッファーに情報を書き込めなかった場合、メソッドはSTATUS_BUFFER_TOO_SMALLを返します。 *ResultLength に書き込まれた値は、要求されたすべての情報を保持するために必要な最小バッファーサイズを示します。