RegEnumValueW

関数

指定キー配下の値をインデックス指定で列挙する。

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

シグネチャ

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

WIN32_ERROR RegEnumValueW(
    HKEY hKey,
    DWORD dwIndex,
    LPWSTR lpValueName,   // optional
    DWORD* lpcchValueName,
    DWORD* lpReserved,   // optional
    DWORD* lpType,   // optional
    BYTE* lpData,   // optional
    DWORD* lpcbData   // optional
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	開いているレジストリキーへのハンドル。キーは KEY_QUERY_VALUE アクセス権で開かれている必要があります。詳細については、 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	取得する値のインデックス。このパラメーターは、 RegEnumValue 関数の最初の呼び出しではゼロを指定し、その後の呼び出しでは増加させてください。値には順序がないため、新しい値は任意のインデックスを持ちます。つまり、この関数は値を任意の順序で返す可能性があります。
lpValueName	LPWSTR	outoptional	値の名前を null 終端文字列として受け取るバッファーへのポインター。このバッファーは、終端の null 文字を含めるのに十分な大きさである必要があります。詳細については、 Registry Element Size Limits を参照してください。
lpcchValueName	DWORD*	inout	lpValueName パラメーターが指すバッファーのサイズを文字数で指定する変数へのポインター。関数が返るとき、この変数は終端の null 文字を含まない、バッファーに格納された文字数を受け取ります。レジストリの値の名前は 32,767 バイトに制限されています。この関数の ANSI バージョンは、このパラメーターを SHORT 値として扱います。そのため、32,767 バイトを超える値を指定するとオーバーフローが発生し、関数が ERROR_MORE_DATA を返す可能性があります。
lpReserved	DWORD*	optional	このパラメーターは予約されており、NULL である必要があります。
lpType	DWORD*	outoptional	指定された値に格納されているデータの種類を示すコードを受け取る変数へのポインター。指定可能な種類コードの一覧については、 Registry Value Types を参照してください。種類コードが不要な場合、lpType パラメーターには NULL を指定できます。
lpData	BYTE*	outoptional	値エントリのデータを受け取るバッファーへのポインター。データが不要な場合、このパラメーターには NULL を指定できます。 lpData が NULL で、lpcbData が非 NULL の場合、関数は lpcbData が指す変数にデータのサイズをバイト単位で格納します。これにより、アプリケーションはデータ用バッファーを割り当てる最適な方法を判断できます。
lpcbData	DWORD*	inoutoptional	lpData パラメーターが指すバッファーのサイズをバイト単位で指定する変数へのポインター。関数が返るとき、この変数はバッファーに格納されたバイト数を受け取ります。このパラメーターに NULL を指定できるのは、lpData が NULL の場合のみです。データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、このサイズには終端の null 文字が含まれます。詳細については、「解説」を参照してください。 lpData で指定されたバッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを lpcbData が指す変数に格納します。この場合、lpData の内容は未定義です。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された開いているレジストリキーの値を列挙します。この関数は、呼び出されるたびに、キーのインデックス付けされた値の名前とデータブロックを 1 つコピーします。(Unicode)

戻り値

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

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

lpData バッファーが値を受け取るには小さすぎる場合、関数は ERROR_MORE_DATA を返します。

解説(Remarks)

値を列挙するには、アプリケーションはまず dwIndex パラメーターをゼロに設定して RegEnumValue 関数を呼び出します。次に、値がなくなるまで (関数が ERROR_NO_MORE_ITEMS を返すまで) dwIndex を増加させながら RegEnumValue 関数を呼び出します。

また、関数の最初の呼び出しで dwIndex を最後の値のインデックスに設定し、インデックス 0 の値が列挙されるまでインデックスを減少させることもできます。最後の値のインデックスを取得するには、 RegQueryInfoKey 関数を使用します。

RegEnumValue の使用中は、アプリケーションは照会対象のキーを変更する可能性のあるレジストリ関数を呼び出さないようにしてください。

データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、文字列が適切な null 終端文字とともに格納されていない可能性があります。そのため、関数が ERROR_SUCCESS を返した場合でも、アプリケーションは文字列を使用する前に適切に終端されていることを確認する必要があります。そうしないと、バッファーを上書きする可能性があります。(REG_MULTI_SZ 文字列には 2 つの null 終端文字が必要であることに注意してください。)

名前およびデータバッファーの最大サイズを判断するには、 RegQueryInfoKey 関数を使用します。

例

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegEnumValueW(
    HKEY hKey,
    DWORD dwIndex,
    LPWSTR lpValueName,   // optional
    DWORD* lpcchValueName,
    DWORD* lpReserved,   // optional
    DWORD* lpType,   // optional
    BYTE* lpData,   // optional
    DWORD* lpcbData   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RegEnumValueW(
    IntPtr hKey,   // HKEY
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpValueName,   // LPWSTR optional, out
    ref uint lpcchValueName,   // DWORD* in/out
    IntPtr lpReserved,   // DWORD* optional
    IntPtr lpType,   // DWORD* optional, out
    IntPtr lpData,   // BYTE* optional, out
    IntPtr lpcbData   // DWORD* optional, in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RegEnumValueW(
    hKey As IntPtr,   ' HKEY
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpValueName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef lpcchValueName As UInteger,   ' DWORD* in/out
    lpReserved As IntPtr,   ' DWORD* optional
    lpType As IntPtr,   ' DWORD* optional, out
    lpData As IntPtr,   ' BYTE* optional, out
    lpcbData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hKey : HKEY
' dwIndex : DWORD
' lpValueName : LPWSTR optional, out
' lpcchValueName : DWORD* in/out
' lpReserved : DWORD* optional
' lpType : DWORD* optional, out
' lpData : BYTE* optional, out
' lpcbData : DWORD* optional, in/out
Declare PtrSafe Function RegEnumValueW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal lpValueName As LongPtr, _
    ByRef lpcchValueName As Long, _
    ByVal lpReserved As LongPtr, _
    ByVal lpType As LongPtr, _
    ByVal lpData As LongPtr, _
    ByVal lpcbData As LongPtr) 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

RegEnumValueW = ctypes.windll.advapi32.RegEnumValueW
RegEnumValueW.restype = wintypes.DWORD
RegEnumValueW.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPWSTR,  # lpValueName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcchValueName : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpReserved : DWORD* optional
    ctypes.POINTER(wintypes.DWORD),  # lpType : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # lpData : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbData : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegEnumValueW = Fiddle::Function.new(
  lib['RegEnumValueW'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpValueName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchValueName : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpReserved : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpData : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbData : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn RegEnumValueW(
        hKey: *mut core::ffi::c_void,  // HKEY
        dwIndex: u32,  // DWORD
        lpValueName: *mut u16,  // LPWSTR optional, out
        lpcchValueName: *mut u32,  // DWORD* in/out
        lpReserved: *mut u32,  // DWORD* optional
        lpType: *mut u32,  // DWORD* optional, out
        lpData: *mut u8,  // BYTE* optional, out
        lpcbData: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint RegEnumValueW(IntPtr hKey, uint dwIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpValueName, ref uint lpcchValueName, IntPtr lpReserved, IntPtr lpType, IntPtr lpData, IntPtr lpcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegEnumValueW' -Namespace Win32 -PassThru
# $api::RegEnumValueW(hKey, dwIndex, lpValueName, lpcchValueName, lpReserved, lpType, lpData, lpcbData)

#uselib "ADVAPI32.dll"
#func global RegEnumValueW "RegEnumValueW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; RegEnumValueW hKey, dwIndex, varptr(lpValueName), varptr(lpcchValueName), varptr(lpReserved), varptr(lpType), varptr(lpData), varptr(lpcbData)   ; 戻り値は stat
; hKey : HKEY -> "wptr"
; dwIndex : DWORD -> "wptr"
; lpValueName : LPWSTR optional, out -> "wptr"
; lpcchValueName : DWORD* in/out -> "wptr"
; lpReserved : DWORD* optional -> "wptr"
; lpType : DWORD* optional, out -> "wptr"
; lpData : BYTE* optional, out -> "wptr"
; lpcbData : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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