IRegistryKey::EnumerateValueKey メソッド (portcls.h)
EnumerateValueKey メソッドは、値キーを含むレジストリ エントリに関する情報を返します。
構文
NTSTATUS EnumerateValueKey(
[in] ULONG Index,
[in] KEY_VALUE_INFORMATION_CLASS KeyValueInformationClass,
[out] PVOID KeyValueInformation,
[in] ULONG Length,
[out] PULONG ResultLength
);
パラメーター
[in] Index
サブキー インデックスを指定します。 このパラメーターは、値が要求されたサブキーを識別します。 キーに n サブキー 含まれている場合、有効なインデックスの範囲は 0 から n-1 です。 インデックスがこの範囲を超えた場合、メソッドはSTATUS_NO_MORE_ENTRIESを返します。
[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
KeyValueInformation バッファーのバイト単位のサイズ。呼び出し元は、指定された KeyValueInformationClassに従って設定する必要があります。 呼び出しを成功させるには、バッファーが少なくとも、メソッドがバッファーに書き込むデータと同じ大きさにする必要があります。
[out] ResultLength
結果のデータの長さの出力ポインター。 このパラメーターは、メソッドが実際に KeyValueInformation バッファーに書き込まれたバイト数を指定するカウントを書き込む呼び出し元によって割り当てられた ULONG 変数を指します。 ただし、指定されたバッファー長が小さすぎて情報を含めすぎる場合、メソッドは代わりに必要なバッファー サイズを出力し、STATUS_BUFFER_OVERFLOWを返します。
戻り値
EnumerateValueKey は、要求された情報を KeyValueInformation バッファーにコピーする呼び出しが成功した場合にSTATUS_SUCCESSを返します。 指定したバッファー サイズが小さすぎて使用可能なすべての情報を受信できない場合、メソッドはSTATUS_BUFFER_OVERFLOWを返します。 それ以外の場合、メソッドは適切なエラー コードを返します。 次の表に、考えられる戻り状態コードの一部を示します。
| リターン コード | 形容 |
|---|---|
|
指定したバッファーが小さすぎて情報を受信できません。 |
|
メソッドに渡されたパラメーターの 1 つが無効であることを示します。 |
|
使用できる値キーがなくなったことを示します (Index パラメーターが値キーの数以上です)。 |
必要条件
| 要件 | 価値 |
|---|---|
| ターゲット プラットフォーム の | 万国 |
| ヘッダー | portcls.h (Portcls.h を含む) |
| IRQL | PASSIVE_LEVEL |