RegEnumKeyExA

関数

サブキー名やクラス、最終更新時刻を列挙して取得する。

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

シグネチャ

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

WIN32_ERROR RegEnumKeyExA(
    HKEY hKey,
    DWORD dwIndex,
    LPSTR lpName,   // optional
    DWORD* lpcchName,
    DWORD* lpReserved,   // optional
    LPSTR lpClass,   // optional
    DWORD* lpcchClass,   // optional
    FILETIME* lpftLastWriteTime   // optional
);

パラメーター

名前	型	方向	説明
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_PERFORMANCE_DATA HKEY_USERS
dwIndex	DWORD	in	取得するサブキーのインデックス。このパラメーターは、 RegEnumKeyEx 関数の最初の呼び出しではゼロにし、以降の呼び出しでは増分する必要があります。サブキーは順序付けられていないため、新しいサブキーには任意のインデックスが割り当てられます。これは、関数がサブキーを任意の順序で返す可能性があることを意味します。
lpName	LPSTR	outoptional	サブキーの名前を、終端の null 文字を含めて受け取るバッファーへのポインター。この関数は、完全なキー階層ではなく、サブキーの名前のみをバッファーにコピーします。関数が失敗した場合、このバッファーには情報はコピーされません。詳細については、 Registry Element Size Limits を参照してください。
lpcchName	DWORD*	inout	lpName パラメーターで指定されたバッファーのサイズを文字数で指定する変数へのポインター。このサイズには、終端の null 文字を含める必要があります。関数が成功した場合、lpcchName が指す変数には、終端の null 文字を含まない、バッファーに格納された文字数が入ります。必要なバッファーサイズを判断するには、 RegQueryInfoKey 関数を使用して、hKey パラメーターで識別されるキーの最大サブキーのサイズを取得します。
lpReserved	DWORD*	optional	このパラメーターは予約されており、NULL でなければなりません。
lpClass	LPSTR	outoptional	列挙されたサブキーのユーザー定義クラスを受け取るバッファーへのポインター。このパラメーターは NULL でもかまいません。
lpcchClass	DWORD*	inoutoptional	lpClass パラメーターで指定されたバッファーのサイズを文字数で指定する変数へのポインター。このサイズには、終端の null 文字を含める必要があります。関数が成功した場合、lpcchClass には、終端の null 文字を含まない、バッファーに格納された文字数が入ります。このパラメーターは、lpClass が NULL の場合に限り NULL にできます。
lpftLastWriteTime	FILETIME*	outoptional	列挙されたサブキーが最後に書き込まれた時刻を受け取る FILETIME 構造体へのポインター。このパラメーターは NULL でもかまいません。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

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

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

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

解説(Remarks)

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

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

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

特定のレジストリキーにアクセスする操作はリダイレクトされることに注意してください。詳細については、Registry Virtualization および 32-bit and 64-bit Application Data in the Registry を参照してください。

メモ

以前のバージョンの Windows では、この API は kernel32.dll でも公開されています。

例

例については、 Enumerating Registry Subkeys を参照してください。

メモ

winreg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegEnumKeyEx を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、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 RegEnumKeyExA(
    HKEY hKey,
    DWORD dwIndex,
    LPSTR lpName,   // optional
    DWORD* lpcchName,
    DWORD* lpReserved,   // optional
    LPSTR lpClass,   // optional
    DWORD* lpcchClass,   // optional
    FILETIME* lpftLastWriteTime   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegEnumKeyExA(
    IntPtr hKey,   // HKEY
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName,   // LPSTR optional, out
    ref uint lpcchName,   // DWORD* in/out
    IntPtr lpReserved,   // DWORD* optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpClass,   // LPSTR optional, out
    IntPtr lpcchClass,   // DWORD* optional, in/out
    IntPtr lpftLastWriteTime   // FILETIME* optional, out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegEnumKeyExA(
    hKey As IntPtr,   ' HKEY
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpName As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef lpcchName As UInteger,   ' DWORD* in/out
    lpReserved As IntPtr,   ' DWORD* optional
    <MarshalAs(UnmanagedType.LPStr)> lpClass As System.Text.StringBuilder,   ' LPSTR optional, out
    lpcchClass As IntPtr,   ' DWORD* optional, in/out
    lpftLastWriteTime As IntPtr   ' FILETIME* optional, out
) As UInteger
End Function

' hKey : HKEY
' dwIndex : DWORD
' lpName : LPSTR optional, out
' lpcchName : DWORD* in/out
' lpReserved : DWORD* optional
' lpClass : LPSTR optional, out
' lpcchClass : DWORD* optional, in/out
' lpftLastWriteTime : FILETIME* optional, out
Declare PtrSafe Function RegEnumKeyExA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal lpName As String, _
    ByRef lpcchName As Long, _
    ByVal lpReserved As LongPtr, _
    ByVal lpClass As String, _
    ByVal lpcchClass As LongPtr, _
    ByVal lpftLastWriteTime As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegEnumKeyExA = ctypes.windll.advapi32.RegEnumKeyExA
RegEnumKeyExA.restype = wintypes.DWORD
RegEnumKeyExA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPSTR,  # lpName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcchName : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpReserved : DWORD* optional
    wintypes.LPSTR,  # lpClass : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcchClass : DWORD* optional, in/out
    ctypes.c_void_p,  # lpftLastWriteTime : FILETIME* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegEnumKeyExA = Fiddle::Function.new(
  lib['RegEnumKeyExA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchName : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpReserved : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpClass : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchClass : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpftLastWriteTime : FILETIME* optional, out
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegEnumKeyExA(IntPtr hKey, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName, ref uint lpcchName, IntPtr lpReserved, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpClass, IntPtr lpcchClass, IntPtr lpftLastWriteTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegEnumKeyExA' -Namespace Win32 -PassThru
# $api::RegEnumKeyExA(hKey, dwIndex, lpName, lpcchName, lpReserved, lpClass, lpcchClass, lpftLastWriteTime)

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

出力引数:

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