RegEnumKeyExA 関数 (winreg.h)
指定した開いているレジストリ キーのサブキーを列挙します。 関数は、呼び出されるたびに 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 ビットアプリケーション データ」を参照してください。
Note
従来のバージョンの Windows では、この API はkernel32.dllによっても公開されます。
例
例については、「 レジストリ サブキーの列挙」を参照してください。
Note
winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegEnumKeyEx を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winreg.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |