RegEnumKeyA

関数

指定キーのサブキーをインデックス指定で列挙する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegEnumKeyA(
    HKEY hKey,
    DWORD dwIndex,
    LPSTR lpName,   // optional
    DWORD cchName
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	開いているレジストリキーへのハンドル。このキーは KEY_ENUMERATE_SUB_KEYS アクセス権で開かれている必要があります。詳細については、 Registry Key Security and Access Rights を参照してください。このハンドルは、 RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。次のいずれかの定義済みキーを指定することもできます: HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS
dwIndex	DWORD	in	取得する hKey のサブキーのインデックス。この値は、 RegEnumKey 関数の最初の呼び出しではゼロにし、それ以降の呼び出しでは増分する必要があります。サブキーには順序が付いていないため、新しいサブキーには任意のインデックスが割り当てられます。つまり、この関数はサブキーを任意の順序で返す可能性があります。
lpName	LPSTR	outoptional	サブキーの名前(終端の null 文字を含む)を受け取るバッファへのポインター。この関数は、完全なキー階層ではなく、サブキーの名前のみをバッファにコピーします。詳細については、 Registry Element Size Limits を参照してください。
cchName	DWORD	in	lpName パラメーターが指すバッファのサイズ(TCHAR 単位)。必要なバッファサイズを判断するには、 RegQueryInfoKey 関数を使用して、hKey パラメーターで識別されるキーの最大サブキーのサイズを求めます。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された開いているレジストリキーのサブキーを列挙します。(RegEnumKeyA)

戻り値

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

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

lpName バッファがキーの名前を受け取るには小さすぎる場合、関数は ERROR_MORE_DATA を返します。

解説(Remarks)

サブキーを列挙するには、アプリケーションはまず dwIndex パラメーターをゼロに設定して RegEnumKey 関数を呼び出す必要があります。その後、アプリケーションは dwIndex パラメーターを増分しながら、サブキーがなくなる(関数が ERROR_NO_MORE_ITEMS を返す)まで RegEnumKey 関数を呼び出します。

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

アプリケーションが RegEnumKey 関数を使用している間は、照会中のキーを変更する可能性のあるレジストリ関数を呼び出さないようにする必要があります。

メモ

winreg.h ヘッダーは RegEnumKey を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が発生し、コンパイルエラーまたは実行時エラーを招く可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegEnumKeyA(
    HKEY hKey,
    DWORD dwIndex,
    LPSTR lpName,   // optional
    DWORD cchName
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegEnumKeyA(
    IntPtr hKey,   // HKEY
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName,   // LPSTR optional, out
    uint cchName   // DWORD
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegEnumKeyA(
    hKey As IntPtr,   ' HKEY
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpName As System.Text.StringBuilder,   ' LPSTR optional, out
    cchName As UInteger   ' DWORD
) As UInteger
End Function

' hKey : HKEY
' dwIndex : DWORD
' lpName : LPSTR optional, out
' cchName : DWORD
Declare PtrSafe Function RegEnumKeyA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal lpName As String, _
    ByVal cchName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegEnumKeyA = ctypes.windll.advapi32.RegEnumKeyA
RegEnumKeyA.restype = wintypes.DWORD
RegEnumKeyA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPSTR,  # lpName : LPSTR optional, out
    wintypes.DWORD,  # cchName : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegEnumKeyA = Fiddle::Function.new(
  lib['RegEnumKeyA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpName : LPSTR optional, out
    -Fiddle::TYPE_INT,  # cchName : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegEnumKeyA(
        hKey: *mut core::ffi::c_void,  // HKEY
        dwIndex: u32,  // DWORD
        lpName: *mut u8,  // LPSTR optional, out
        cchName: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegEnumKeyA(IntPtr hKey, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName, uint cchName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegEnumKeyA' -Namespace Win32 -PassThru
# $api::RegEnumKeyA(hKey, dwIndex, lpName, cchName)

#uselib "ADVAPI32.dll"
#func global RegEnumKeyA "RegEnumKeyA" sptr, sptr, sptr, sptr
; RegEnumKeyA hKey, dwIndex, varptr(lpName), cchName   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; dwIndex : DWORD -> "sptr"
; lpName : LPSTR optional, out -> "sptr"
; cchName : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegEnumKeyA "RegEnumKeyA" sptr, int, var, int
; res = RegEnumKeyA(hKey, dwIndex, lpName, cchName)
; hKey : HKEY -> "sptr"
; dwIndex : DWORD -> "int"
; lpName : LPSTR optional, out -> "var"
; cchName : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegEnumKeyA "RegEnumKeyA" sptr, int, sptr, int
; res = RegEnumKeyA(hKey, dwIndex, varptr(lpName), cchName)
; hKey : HKEY -> "sptr"
; dwIndex : DWORD -> "int"
; lpName : LPSTR optional, out -> "sptr"
; cchName : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。