RegEnumKeyA 関数 (winreg.h)

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

メモ この関数は、16 ビット バージョンの Windows との互換性のためにのみ提供されます。 アプリケーションでは 、RegEnumKeyEx 関数を使用する必要があります。
 

構文

LSTATUS RegEnumKeyA(
  [in]  HKEY  hKey,
  [in]  DWORD dwIndex,
  [out] LPSTR lpName,
  [in]  DWORD cchName
);

パラメーター

[in] hKey

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

このハンドルは、 RegCreateKeyExRegCreateKeyTransactedRegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。 また、次の 定義済みキーのいずれかを指定することもできます。

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS

[in] dwIndex

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

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

[out] lpName

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

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

[in] cchName

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

戻り値

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

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

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

解説

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

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

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

注意

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

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winreg.h (Windows.h を含む)
Library Advapi32.lib
[DLL] Advapi32.dll

関連項目

RegCloseKey

RegCreateKeyEx

RegDeleteKey

RegEnumKeyEx

RegOpenKeyEx

RegQueryInfoKey

レジストリ関数

レジストリの概要