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

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

メソッドは EnumerateKey 、開いているキーのサブキーに関する情報を返します。

構文

NTSTATUS EnumerateKey(
  [in]  ULONG                 Index,
  [in]  KEY_INFORMATION_CLASS KeyInformationClass,
  [out] PVOID                 KeyInformation,
  [in]  ULONG                 Length,
  [out] PULONG                ResultLength
);

パラメーター

[in] Index

サブキーインデックスを指定します。このパラメーターは、キー情報が要求されるサブキーを識別します。キーに n 個のサブキーが含まれている場合、有効なインデックスの範囲は 0 から n から 1 です。インデックスがこの範囲を超えた場合、メソッドは STATUS_NO_MORE_ENTRIESを返します。

[in] KeyInformationClass

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

KeyBasicInformation
KeyFullInformation
KeyNodeInformation

[out] KeyInformation

キー情報バッファーへのポインター。このパラメーターは、メソッドが要求されたデータを書き込む呼び出し元によって割り当てられたバッファーを指します。バッファーには、KeyInformationClass の値に応じて、KEY_BASIC_INFORMATION型、KEY_FULL_INFORMATION型、またはKEY_NODE_INFORMATION型の構造体が含まれています。構造体の後には、キーに関して要求される情報の種類に応じてサイズが異なる Unicode 文字の文字列が続きます。

[in] Length

指定された KeyInformationClass に従って呼び出し元が設定する必要がある KeyInformation バッファーのサイズをバイト単位で指定します。呼び出しを成功させるには、バッファーは、メソッドがバッファーに書き込むデータと少なくとも同じ大きさにする必要があります。

[out] ResultLength

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

戻り値

EnumerateKey は、呼び出しが KeyInformation バッファーで要求された情報の取得に成功した場合にSTATUS_SUCCESSを返します。指定したバッファーサイズが小さすぎて使用可能なすべての情報を受信できない場合、メソッドは STATUS_BUFFER_OVERFLOWを返します。それ以外の場合、メソッドは適切なエラーコードを返します。次の表は、可能な戻り状態コードの一部を示しています。

リターンコード	説明
STATUS_BUFFER_TOO_SMALL	指定したバッファーが小さすぎて情報を受信できません。
STATUS_NO_MORE_ENTRIES	サブキーが使用できない (サブキーインデックスがサブキーの数以上である) ことを示します。