SHEnumKeyExA
関数レジストリキーのサブキーをインデックス順に列挙する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR SHEnumKeyExA(
HKEY hkey,
DWORD dwIndex,
LPSTR pszName,
DWORD* pcchName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hkey | HKEY | in | 現在開いているキーへのハンドル、または以下の定義済みの値のいずれか。 HKEY_CLASSES_ROOTHKEY_CURRENT_CONFIGHKEY_CURRENT_USERHKEY_LOCAL_MACHINEHKEY_PERFORMANCE_DATAHKEY_USERS |
| dwIndex | DWORD | in | 取得するサブキーのインデックス。このパラメーターは最初の呼び出しではゼロにし、以降の呼び出しごとに増やします。 |
| pszName | LPSTR | out | 列挙されたキー名を受け取る文字バッファーのアドレス。 |
| pcchName | DWORD* | inout | DWORD のアドレス。入力時には pszName のバッファーのサイズ(文字数)を格納します。終了時には pszName にコピーされた文字数を格納します。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
指定された開いているレジストリ キーのサブキーを列挙します。(SHEnumKeyExA)
戻り値
型: LSTATUS
成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラー コードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーのテキスト説明を取得できます。
解説(Remarks)
メモ
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHEnumKeyEx を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、不一致が生じてコンパイル エラーや実行時エラーの原因となる場合があります。詳細については、「関数プロトタイプの規則」を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR SHEnumKeyExA(
HKEY hkey,
DWORD dwIndex,
LPSTR pszName,
DWORD* pcchName
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHEnumKeyExA(
IntPtr hkey, // HKEY
uint dwIndex, // DWORD
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszName, // LPSTR out
ref uint pcchName // DWORD* in/out
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHEnumKeyExA(
hkey As IntPtr, ' HKEY
dwIndex As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPStr)> pszName As System.Text.StringBuilder, ' LPSTR out
ByRef pcchName As UInteger ' DWORD* in/out
) As UInteger
End Function' hkey : HKEY
' dwIndex : DWORD
' pszName : LPSTR out
' pcchName : DWORD* in/out
Declare PtrSafe Function SHEnumKeyExA Lib "shlwapi" ( _
ByVal hkey As LongPtr, _
ByVal dwIndex As Long, _
ByVal pszName As String, _
ByRef pcchName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHEnumKeyExA = ctypes.windll.shlwapi.SHEnumKeyExA
SHEnumKeyExA.restype = wintypes.DWORD
SHEnumKeyExA.argtypes = [
wintypes.HANDLE, # hkey : HKEY
wintypes.DWORD, # dwIndex : DWORD
wintypes.LPSTR, # pszName : LPSTR out
ctypes.POINTER(wintypes.DWORD), # pcchName : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHEnumKeyExA = Fiddle::Function.new(
lib['SHEnumKeyExA'],
[
Fiddle::TYPE_VOIDP, # hkey : HKEY
-Fiddle::TYPE_INT, # dwIndex : DWORD
Fiddle::TYPE_VOIDP, # pszName : LPSTR out
Fiddle::TYPE_VOIDP, # pcchName : DWORD* in/out
],
-Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn SHEnumKeyExA(
hkey: *mut core::ffi::c_void, // HKEY
dwIndex: u32, // DWORD
pszName: *mut u8, // LPSTR out
pcchName: *mut u32 // DWORD* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint SHEnumKeyExA(IntPtr hkey, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszName, ref uint pcchName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHEnumKeyExA' -Namespace Win32 -PassThru
# $api::SHEnumKeyExA(hkey, dwIndex, pszName, pcchName)#uselib "SHLWAPI.dll"
#func global SHEnumKeyExA "SHEnumKeyExA" sptr, sptr, sptr, sptr
; SHEnumKeyExA hkey, dwIndex, varptr(pszName), varptr(pcchName) ; 戻り値は stat
; hkey : HKEY -> "sptr"
; dwIndex : DWORD -> "sptr"
; pszName : LPSTR out -> "sptr"
; pcchName : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExA "SHEnumKeyExA" sptr, int, var, var ; res = SHEnumKeyExA(hkey, dwIndex, pszName, pcchName) ; hkey : HKEY -> "sptr" ; dwIndex : DWORD -> "int" ; pszName : LPSTR out -> "var" ; pcchName : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExA "SHEnumKeyExA" sptr, int, sptr, sptr ; res = SHEnumKeyExA(hkey, dwIndex, varptr(pszName), varptr(pcchName)) ; hkey : HKEY -> "sptr" ; dwIndex : DWORD -> "int" ; pszName : LPSTR out -> "sptr" ; pcchName : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; WIN32_ERROR SHEnumKeyExA(HKEY hkey, DWORD dwIndex, LPSTR pszName, DWORD* pcchName) #uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExA "SHEnumKeyExA" intptr, int, var, var ; res = SHEnumKeyExA(hkey, dwIndex, pszName, pcchName) ; hkey : HKEY -> "intptr" ; dwIndex : DWORD -> "int" ; pszName : LPSTR out -> "var" ; pcchName : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR SHEnumKeyExA(HKEY hkey, DWORD dwIndex, LPSTR pszName, DWORD* pcchName) #uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExA "SHEnumKeyExA" intptr, int, intptr, intptr ; res = SHEnumKeyExA(hkey, dwIndex, varptr(pszName), varptr(pcchName)) ; hkey : HKEY -> "intptr" ; dwIndex : DWORD -> "int" ; pszName : LPSTR out -> "intptr" ; pcchName : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHEnumKeyExA = shlwapi.NewProc("SHEnumKeyExA")
)
// hkey (HKEY), dwIndex (DWORD), pszName (LPSTR out), pcchName (DWORD* in/out)
r1, _, err := procSHEnumKeyExA.Call(
uintptr(hkey),
uintptr(dwIndex),
uintptr(pszName),
uintptr(pcchName),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction SHEnumKeyExA(
hkey: THandle; // HKEY
dwIndex: DWORD; // DWORD
pszName: PAnsiChar; // LPSTR out
pcchName: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHEnumKeyExA';result := DllCall("SHLWAPI\SHEnumKeyExA"
, "Ptr", hkey ; HKEY
, "UInt", dwIndex ; DWORD
, "Ptr", pszName ; LPSTR out
, "Ptr", pcchName ; DWORD* in/out
, "UInt") ; return: WIN32_ERROR●SHEnumKeyExA(hkey, dwIndex, pszName, pcchName) = DLL("SHLWAPI.dll", "dword SHEnumKeyExA(void*, dword, char*, void*)")
# 呼び出し: SHEnumKeyExA(hkey, dwIndex, pszName, pcchName)
# hkey : HKEY -> "void*"
# dwIndex : DWORD -> "dword"
# pszName : LPSTR out -> "char*"
# pcchName : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn SHEnumKeyExA(
hkey: ?*anyopaque, // HKEY
dwIndex: u32, // DWORD
pszName: [*c]u8, // LPSTR out
pcchName: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;proc SHEnumKeyExA(
hkey: pointer, # HKEY
dwIndex: uint32, # DWORD
pszName: ptr char, # LPSTR out
pcchName: ptr uint32 # DWORD* in/out
): uint32 {.importc: "SHEnumKeyExA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
uint SHEnumKeyExA(
void* hkey, // HKEY
uint dwIndex, // DWORD
char* pszName, // LPSTR out
uint* pcchName // DWORD* in/out
);ccall((:SHEnumKeyExA, "SHLWAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, UInt32, Ptr{UInt8}, Ptr{UInt32}),
hkey, dwIndex, pszName, pcchName)
# hkey : HKEY -> Ptr{Cvoid}
# dwIndex : DWORD -> UInt32
# pszName : LPSTR out -> Ptr{UInt8}
# pcchName : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t SHEnumKeyExA(
void* hkey,
uint32_t dwIndex,
char* pszName,
uint32_t* pcchName);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHEnumKeyExA(hkey, dwIndex, pszName, pcchName)
-- hkey : HKEY
-- dwIndex : DWORD
-- pszName : LPSTR out
-- pcchName : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHEnumKeyExA = lib.func('__stdcall', 'SHEnumKeyExA', 'uint32_t', ['void *', 'uint32_t', 'char *', 'uint32_t *']);
// SHEnumKeyExA(hkey, dwIndex, pszName, pcchName)
// hkey : HKEY -> 'void *'
// dwIndex : DWORD -> 'uint32_t'
// pszName : LPSTR out -> 'char *'
// pcchName : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHEnumKeyExA: { parameters: ["pointer", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.SHEnumKeyExA(hkey, dwIndex, pszName, pcchName)
// hkey : HKEY -> "pointer"
// dwIndex : DWORD -> "u32"
// pszName : LPSTR out -> "buffer"
// pcchName : DWORD* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t SHEnumKeyExA(
void* hkey,
uint32_t dwIndex,
char* pszName,
uint32_t* pcchName);
C, "SHLWAPI.dll");
// $ffi->SHEnumKeyExA(hkey, dwIndex, pszName, pcchName);
// hkey : HKEY
// dwIndex : DWORD
// pszName : LPSTR out
// pcchName : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
int SHEnumKeyExA(
Pointer hkey, // HKEY
int dwIndex, // DWORD
byte[] pszName, // LPSTR out
IntByReference pcchName // DWORD* in/out
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun SHEnumKeyExA = SHEnumKeyExA(
hkey : Void*, # HKEY
dwIndex : UInt32, # DWORD
pszName : UInt8*, # LPSTR out
pcchName : UInt32* # DWORD* in/out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHEnumKeyExANative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf8>, Pointer<Uint32>);
typedef SHEnumKeyExADart = int Function(Pointer<Void>, int, Pointer<Utf8>, Pointer<Uint32>);
final SHEnumKeyExA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHEnumKeyExANative, SHEnumKeyExADart>('SHEnumKeyExA');
// hkey : HKEY -> Pointer<Void>
// dwIndex : DWORD -> Uint32
// pszName : LPSTR out -> Pointer<Utf8>
// pcchName : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHEnumKeyExA(
hkey: THandle; // HKEY
dwIndex: DWORD; // DWORD
pszName: PAnsiChar; // LPSTR out
pcchName: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHEnumKeyExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHEnumKeyExA"
c_SHEnumKeyExA :: Ptr () -> Word32 -> CString -> Ptr Word32 -> IO Word32
-- hkey : HKEY -> Ptr ()
-- dwIndex : DWORD -> Word32
-- pszName : LPSTR out -> CString
-- pcchName : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shenumkeyexa =
foreign "SHEnumKeyExA"
((ptr void) @-> uint32_t @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* hkey : HKEY -> (ptr void) *)
(* dwIndex : DWORD -> uint32_t *)
(* pszName : LPSTR out -> string *)
(* pcchName : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("SHEnumKeyExA" shenum-key-ex-a :convention :stdcall) :uint32
(hkey :pointer) ; HKEY
(dw-index :uint32) ; DWORD
(psz-name :pointer) ; LPSTR out
(pcch-name :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHEnumKeyExA = Win32::API::More->new('SHLWAPI',
'DWORD SHEnumKeyExA(HANDLE hkey, DWORD dwIndex, LPSTR pszName, LPVOID pcchName)');
# my $ret = $SHEnumKeyExA->Call($hkey, $dwIndex, $pszName, $pcchName);
# hkey : HKEY -> HANDLE
# dwIndex : DWORD -> DWORD
# pszName : LPSTR out -> LPSTR
# pcchName : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SHEnumKeyExW (Unicode版) — レジストリキーのサブキーをインデックス順に列挙する。
使用する型