RegEnumKeyW

関数

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

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR RegEnumKeyW(
    HKEY hKey,
    DWORD dwIndex,
    LPWSTR lpName,   // optional
    DWORD cchName
);

パラメーター

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

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegEnumKey を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR RegEnumKeyW(
    HKEY hKey,
    DWORD dwIndex,
    LPWSTR lpName,   // optional
    DWORD cchName
);

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

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

' hKey : HKEY
' dwIndex : DWORD
' lpName : LPWSTR optional, out
' cchName : DWORD
Declare PtrSafe Function RegEnumKeyW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal lpName As LongPtr, _
    ByVal cchName As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegEnumKeyW = Fiddle::Function.new(
  lib['RegEnumKeyW'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpName : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cchName : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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