SHEnumKeyExW
関数レジストリキーのサブキーをインデックス順に列挙する。
シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR SHEnumKeyExW(
HKEY hkey,
DWORD dwIndex,
LPWSTR pszName,
DWORD* pcchName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hkey | HKEY | in | 現在開いているキーのハンドル、または次の定義済みの値のいずれか。 HKEY_CLASSES_ROOTHKEY_CURRENT_CONFIGHKEY_CURRENT_USERHKEY_LOCAL_MACHINEHKEY_PERFORMANCE_DATAHKEY_USERS |
| dwIndex | DWORD | in | 取得するサブキーのインデックス。このパラメーターは最初の呼び出しでは 0 とし、以降の呼び出しでは値をインクリメントします。 |
| pszName | LPWSTR | out | 列挙されたキー名を受け取る文字バッファーのアドレス。 |
| pcchName | DWORD* | inout | DWORD のアドレス。入力時には pszName のバッファーのサイズ(文字数)を格納します。出力時には pszName にコピーされた文字数を格納します。 - hkey.HKEY_CLASSES_ROOT- hkey.HKEY_CURRENT_CONFIG- hkey.HKEY_CURRENT_USER- hkey.HKEY_LOCAL_MACHINE- hkey.HKEY_PERFORMANCE_DATA- hkey.HKEY_USERS |
戻り値の型: WIN32_ERROR
公式ドキュメント
指定された開いているレジストリキーのサブキーを列挙します。(SHEnumKeyExW)
戻り値
型: 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 (Unicode / -W)
#include <windows.h>
WIN32_ERROR SHEnumKeyExW(
HKEY hkey,
DWORD dwIndex,
LPWSTR pszName,
DWORD* pcchName
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHEnumKeyExW(
IntPtr hkey, // HKEY
uint dwIndex, // DWORD
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszName, // LPWSTR out
ref uint pcchName // DWORD* in/out
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHEnumKeyExW(
hkey As IntPtr, ' HKEY
dwIndex As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPWStr)> pszName As System.Text.StringBuilder, ' LPWSTR out
ByRef pcchName As UInteger ' DWORD* in/out
) As UInteger
End Function' hkey : HKEY
' dwIndex : DWORD
' pszName : LPWSTR out
' pcchName : DWORD* in/out
Declare PtrSafe Function SHEnumKeyExW Lib "shlwapi" ( _
ByVal hkey As LongPtr, _
ByVal dwIndex As Long, _
ByVal pszName As LongPtr, _
ByRef pcchName 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
SHEnumKeyExW = ctypes.windll.shlwapi.SHEnumKeyExW
SHEnumKeyExW.restype = wintypes.DWORD
SHEnumKeyExW.argtypes = [
wintypes.HANDLE, # hkey : HKEY
wintypes.DWORD, # dwIndex : DWORD
wintypes.LPWSTR, # pszName : LPWSTR out
ctypes.POINTER(wintypes.DWORD), # pcchName : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHEnumKeyExW = Fiddle::Function.new(
lib['SHEnumKeyExW'],
[
Fiddle::TYPE_VOIDP, # hkey : HKEY
-Fiddle::TYPE_INT, # dwIndex : DWORD
Fiddle::TYPE_VOIDP, # pszName : LPWSTR out
Fiddle::TYPE_VOIDP, # pcchName : DWORD* in/out
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn SHEnumKeyExW(
hkey: *mut core::ffi::c_void, // HKEY
dwIndex: u32, // DWORD
pszName: *mut u16, // LPWSTR out
pcchName: *mut u32 // DWORD* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHEnumKeyExW(IntPtr hkey, uint dwIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszName, ref uint pcchName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHEnumKeyExW' -Namespace Win32 -PassThru
# $api::SHEnumKeyExW(hkey, dwIndex, pszName, pcchName)#uselib "SHLWAPI.dll"
#func global SHEnumKeyExW "SHEnumKeyExW" wptr, wptr, wptr, wptr
; SHEnumKeyExW hkey, dwIndex, varptr(pszName), varptr(pcchName) ; 戻り値は stat
; hkey : HKEY -> "wptr"
; dwIndex : DWORD -> "wptr"
; pszName : LPWSTR out -> "wptr"
; pcchName : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExW "SHEnumKeyExW" sptr, int, var, var ; res = SHEnumKeyExW(hkey, dwIndex, pszName, pcchName) ; hkey : HKEY -> "sptr" ; dwIndex : DWORD -> "int" ; pszName : LPWSTR out -> "var" ; pcchName : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExW "SHEnumKeyExW" sptr, int, sptr, sptr ; res = SHEnumKeyExW(hkey, dwIndex, varptr(pszName), varptr(pcchName)) ; hkey : HKEY -> "sptr" ; dwIndex : DWORD -> "int" ; pszName : LPWSTR out -> "sptr" ; pcchName : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; WIN32_ERROR SHEnumKeyExW(HKEY hkey, DWORD dwIndex, LPWSTR pszName, DWORD* pcchName) #uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExW "SHEnumKeyExW" intptr, int, var, var ; res = SHEnumKeyExW(hkey, dwIndex, pszName, pcchName) ; hkey : HKEY -> "intptr" ; dwIndex : DWORD -> "int" ; pszName : LPWSTR out -> "var" ; pcchName : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR SHEnumKeyExW(HKEY hkey, DWORD dwIndex, LPWSTR pszName, DWORD* pcchName) #uselib "SHLWAPI.dll" #cfunc global SHEnumKeyExW "SHEnumKeyExW" intptr, int, intptr, intptr ; res = SHEnumKeyExW(hkey, dwIndex, varptr(pszName), varptr(pcchName)) ; hkey : HKEY -> "intptr" ; dwIndex : DWORD -> "int" ; pszName : LPWSTR out -> "intptr" ; pcchName : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHEnumKeyExW = shlwapi.NewProc("SHEnumKeyExW")
)
// hkey (HKEY), dwIndex (DWORD), pszName (LPWSTR out), pcchName (DWORD* in/out)
r1, _, err := procSHEnumKeyExW.Call(
uintptr(hkey),
uintptr(dwIndex),
uintptr(pszName),
uintptr(pcchName),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction SHEnumKeyExW(
hkey: THandle; // HKEY
dwIndex: DWORD; // DWORD
pszName: PWideChar; // LPWSTR out
pcchName: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHEnumKeyExW';result := DllCall("SHLWAPI\SHEnumKeyExW"
, "Ptr", hkey ; HKEY
, "UInt", dwIndex ; DWORD
, "Ptr", pszName ; LPWSTR out
, "Ptr", pcchName ; DWORD* in/out
, "UInt") ; return: WIN32_ERROR●SHEnumKeyExW(hkey, dwIndex, pszName, pcchName) = DLL("SHLWAPI.dll", "dword SHEnumKeyExW(void*, dword, char*, void*)")
# 呼び出し: SHEnumKeyExW(hkey, dwIndex, pszName, pcchName)
# hkey : HKEY -> "void*"
# dwIndex : DWORD -> "dword"
# pszName : LPWSTR out -> "char*"
# pcchName : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn SHEnumKeyExW(
hkey: ?*anyopaque, // HKEY
dwIndex: u32, // DWORD
pszName: [*c]u16, // LPWSTR out
pcchName: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHEnumKeyExW(
hkey: pointer, # HKEY
dwIndex: uint32, # DWORD
pszName: ptr uint16, # LPWSTR out
pcchName: ptr uint32 # DWORD* in/out
): uint32 {.importc: "SHEnumKeyExW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
uint SHEnumKeyExW(
void* hkey, // HKEY
uint dwIndex, // DWORD
wchar* pszName, // LPWSTR out
uint* pcchName // DWORD* in/out
);ccall((:SHEnumKeyExW, "SHLWAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, UInt32, Ptr{UInt16}, Ptr{UInt32}),
hkey, dwIndex, pszName, pcchName)
# hkey : HKEY -> Ptr{Cvoid}
# dwIndex : DWORD -> UInt32
# pszName : LPWSTR out -> Ptr{UInt16}
# pcchName : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t SHEnumKeyExW(
void* hkey,
uint32_t dwIndex,
uint16_t* pszName,
uint32_t* pcchName);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHEnumKeyExW(hkey, dwIndex, pszName, pcchName)
-- hkey : HKEY
-- dwIndex : DWORD
-- pszName : LPWSTR out
-- pcchName : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHEnumKeyExW = lib.func('__stdcall', 'SHEnumKeyExW', 'uint32_t', ['void *', 'uint32_t', 'uint16_t *', 'uint32_t *']);
// SHEnumKeyExW(hkey, dwIndex, pszName, pcchName)
// hkey : HKEY -> 'void *'
// dwIndex : DWORD -> 'uint32_t'
// pszName : LPWSTR out -> 'uint16_t *'
// pcchName : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHEnumKeyExW: { parameters: ["pointer", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.SHEnumKeyExW(hkey, dwIndex, pszName, pcchName)
// hkey : HKEY -> "pointer"
// dwIndex : DWORD -> "u32"
// pszName : LPWSTR out -> "buffer"
// pcchName : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t SHEnumKeyExW(
void* hkey,
uint32_t dwIndex,
uint16_t* pszName,
uint32_t* pcchName);
C, "SHLWAPI.dll");
// $ffi->SHEnumKeyExW(hkey, dwIndex, pszName, pcchName);
// hkey : HKEY
// dwIndex : DWORD
// pszName : LPWSTR 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.UNICODE_OPTIONS);
int SHEnumKeyExW(
Pointer hkey, // HKEY
int dwIndex, // DWORD
char[] pszName, // LPWSTR out
IntByReference pcchName // DWORD* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun SHEnumKeyExW = SHEnumKeyExW(
hkey : Void*, # HKEY
dwIndex : UInt32, # DWORD
pszName : UInt16*, # LPWSTR 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 SHEnumKeyExWNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef SHEnumKeyExWDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Uint32>);
final SHEnumKeyExW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHEnumKeyExWNative, SHEnumKeyExWDart>('SHEnumKeyExW');
// hkey : HKEY -> Pointer<Void>
// dwIndex : DWORD -> Uint32
// pszName : LPWSTR out -> Pointer<Utf16>
// pcchName : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHEnumKeyExW(
hkey: THandle; // HKEY
dwIndex: DWORD; // DWORD
pszName: PWideChar; // LPWSTR out
pcchName: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHEnumKeyExW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHEnumKeyExW"
c_SHEnumKeyExW :: Ptr () -> Word32 -> CWString -> Ptr Word32 -> IO Word32
-- hkey : HKEY -> Ptr ()
-- dwIndex : DWORD -> Word32
-- pszName : LPWSTR out -> CWString
-- pcchName : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shenumkeyexw =
foreign "SHEnumKeyExW"
((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hkey : HKEY -> (ptr void) *)
(* dwIndex : DWORD -> uint32_t *)
(* pszName : LPWSTR out -> (ptr uint16_t) *)
(* 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 ("SHEnumKeyExW" shenum-key-ex-w :convention :stdcall) :uint32
(hkey :pointer) ; HKEY
(dw-index :uint32) ; DWORD
(psz-name :pointer) ; LPWSTR out
(pcch-name :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHEnumKeyExW = Win32::API::More->new('SHLWAPI',
'DWORD SHEnumKeyExW(HANDLE hkey, DWORD dwIndex, LPWSTR pszName, LPVOID pcchName)');
# my $ret = $SHEnumKeyExW->Call($hkey, $dwIndex, $pszName, $pcchName);
# hkey : HKEY -> HANDLE
# dwIndex : DWORD -> DWORD
# pszName : LPWSTR out -> LPWSTR
# pcchName : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SHEnumKeyExA (ANSI版) — レジストリキーのサブキーをインデックス順に列挙する。
使用する型