RegEnumKeyExA 関数 (winreg.h)

[アーティクル]
11/20/2024

指定した開いているレジストリキーのサブキーを列挙します。この関数は、呼び出されるたびに 1 つのサブキーに関する情報を取得します。

構文

LSTATUS RegEnumKeyExA(
  [in]                HKEY      hKey,
  [in]                DWORD     dwIndex,
  [out]               LPSTR     lpName,
  [in, out]           LPDWORD   lpcchName,
                      LPDWORD   lpReserved,
  [in, out]           LPSTR     lpClass,
  [in, out, optional] LPDWORD   lpcchClass,
  [out, optional]     PFILETIME lpftLastWriteTime
);

パラメーター

[in] hKey

開いているレジストリキーへのハンドル。キーは、KEY_ENUMERATE_SUB_KEYSアクセス権で開かれている必要があります。詳細については、「レジストリキーのセキュリティとアクセス権のをする」を参照してください。

このハンドルは、RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数返されます。また、次のいずれかの定義済みキーすることもできます。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in] dwIndex

取得するサブキーのインデックス。このパラメーターは、RegEnumKeyEx 関数の最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。

サブキーは順序付けされないため、新しいサブキーには任意のインデックスがあります。これは、関数が任意の順序でサブキーを返す可能性があることを意味します。

[out] lpName

終端 null 文字を含む、サブキーの名前を受け取るバッファーへのポインター。この関数は、完全なキー階層ではなく、サブキーの名前のみをバッファーにコピーします。

関数が失敗した場合、このバッファーに情報はコピーされません。

詳細については、「レジストリ要素のサイズ制限」を参照してください。

[in, out] lpcchName

lpName パラメーターで指定されたバッファーのサイズを文字で指定する変数へのポインター。このサイズには、終端 null 文字が含まれている必要があります。関数が成功した場合、lpcchName が指す変数には、バッファーに格納されている文字数が含まれます。終端 null 文字は含まれません。

必要なバッファーサイズを決定するには、RegQueryInfoKey 関数を使用して、hKey パラメーターによって識別されるキーの最大サブキーのサイズを決定します。

lpReserved

このパラメーターは予約されており、NULLする必要があります。

[in, out] lpClass

列挙されたサブキーのユーザー定義クラスを受け取るバッファーへのポインター。このパラメーターは NULLできます。

[in, out, optional] lpcchClass

lpClass パラメーターで指定されたバッファーのサイズを文字で指定する変数へのポインター。サイズには、終端 null 文字を含める必要があります。関数が成功した場合、lpcchClass にはバッファーに格納されている文字数が含まれます。終端 null 文字は含まれません。このパラメーターは、lpClass が NULL場合にのみ、NULL できます。

[out, optional] lpftLastWriteTime

列挙されたサブキー最後に書き込まれた時刻を受け取る FILETIME 構造体へのポインター。このパラメーターは NULLできます。

戻り値

関数が成功した場合、戻り値はERROR_SUCCESS。

関数が失敗した場合、戻り値はシステムエラーコードです。使用可能なサブキーがそれ以上ない場合、関数はERROR_NO_MORE_ITEMSを返します。

lpName バッファーが小さすぎてキーの名前を受け取れなければ、関数はERROR_MORE_DATAを返します。

備考

サブキーを列挙するには、アプリケーションは最初に、dwIndex パラメーターを 0 に設定して、RegEnumKeyEx 関数を呼び出す必要があります。その後、アプリケーションは、dwIndex パラメーターをインクリメントし、サブキーがなくなったまで RegEnumKeyEx 呼び出す必要があります (つまり、関数はERROR_NO_MORE_ITEMSを返します)。

また、アプリケーションでは、dwIndex 関数の最初の呼び出しで最後のサブキーのインデックスを設定し、インデックス 0 のサブキーが列挙されるまでインデックスをデクリメントすることもできます。最後のサブキーのインデックスを取得するには、RegQueryInfoKey 関数を使用します。

アプリケーションが RegEnumKeyEx 関数を使用している間は、列挙するキーを変更する可能性のある登録関数を呼び出さないでください。

特定のレジストリキーにアクセスする操作はリダイレクトされることに注意してください。詳細については、「レジストリ仮想化およびレジストリの 32 ビットおよび 64 ビットアプリケーションデータをする」を参照してください。

手記

レガシバージョンの Windows では、この API も kernel32.dllによって公開されます。

例

例については、「レジストリサブキーの列挙」を参照してください。

手記

winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegEnumKeyEx を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	winreg.h (Windows.h を含む)
ライブラリ	Advapi32.lib
DLL	Advapi32.dll

次の方法で共有

RegEnumKeyExA 関数 (winreg.h)

構文

パラメーター

戻り値

備考

例

必要条件

関連項目

フィードバック

その他のリソース