SHRegEnumUSKeyW

関数

ユーザー単位レジストリキーのサブキーを列挙する。

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

シグネチャ

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

WIN32_ERROR SHRegEnumUSKeyW(
    INT_PTR hUSKey,
    DWORD dwIndex,
    LPWSTR pwzName,
    DWORD* pcchName,
    SHREGENUM_FLAGS enumRegFlags
);

パラメーター

名前	型	方向	説明
hUSKey	INT_PTR	in	現在開いているレジストリサブキーへのハンドル。このサブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、Registry Key Security and Access Rights を参照してください。このハンドルは SHRegOpenUSKey 関数を通じて取得できます。
dwIndex	DWORD	in	取得するサブキーのインデックス。このパラメーターは最初の呼び出しでは 0 にし、以降の呼び出しごとにインクリメントします。
pwzName	LPWSTR	out	TBD
pcchName	DWORD*	inout	DWORD へのポインター。入力時には pszName のバッファーのサイズを文字数で格納します。出力時には pszName にコピーされた文字数を格納します。
enumRegFlags	SHREGENUM_FLAGS	in	列挙を行うベースキーを指定する SHREGENUM_FLAGS。 - pszName [out] 型: LPTSTR 列挙されたキー名を受け取る文字バッファーへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内のレジストリサブキーのサブキーを列挙します。(Unicode)

戻り値

型: LSTATUS

成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラーコードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーのテキスト記述を取得できます。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

WIN32_ERROR SHRegEnumUSKeyW(
    INT_PTR hUSKey,
    DWORD dwIndex,
    LPWSTR pwzName,
    DWORD* pcchName,
    SHREGENUM_FLAGS enumRegFlags
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegEnumUSKeyW(
    IntPtr hUSKey,   // INT_PTR
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwzName,   // LPWSTR out
    ref uint pcchName,   // DWORD* in/out
    int enumRegFlags   // SHREGENUM_FLAGS
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegEnumUSKeyW(
    hUSKey As IntPtr,   ' INT_PTR
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwzName As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchName As UInteger,   ' DWORD* in/out
    enumRegFlags As Integer   ' SHREGENUM_FLAGS
) As UInteger
End Function

' hUSKey : INT_PTR
' dwIndex : DWORD
' pwzName : LPWSTR out
' pcchName : DWORD* in/out
' enumRegFlags : SHREGENUM_FLAGS
Declare PtrSafe Function SHRegEnumUSKeyW Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal pwzName As LongPtr, _
    ByRef pcchName As Long, _
    ByVal enumRegFlags 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

SHRegEnumUSKeyW = ctypes.windll.shlwapi.SHRegEnumUSKeyW
SHRegEnumUSKeyW.restype = wintypes.DWORD
SHRegEnumUSKeyW.argtypes = [
    ctypes.c_ssize_t,  # hUSKey : INT_PTR
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPWSTR,  # pwzName : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchName : DWORD* in/out
    ctypes.c_int,  # enumRegFlags : SHREGENUM_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegEnumUSKeyW = Fiddle::Function.new(
  lib['SHRegEnumUSKeyW'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSKey : INT_PTR
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pwzName : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchName : DWORD* in/out
    Fiddle::TYPE_INT,  # enumRegFlags : SHREGENUM_FLAGS
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegEnumUSKeyW(
        hUSKey: isize,  // INT_PTR
        dwIndex: u32,  // DWORD
        pwzName: *mut u16,  // LPWSTR out
        pcchName: *mut u32,  // DWORD* in/out
        enumRegFlags: i32  // SHREGENUM_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHRegEnumUSKeyW(IntPtr hUSKey, uint dwIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwzName, ref uint pcchName, int enumRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegEnumUSKeyW' -Namespace Win32 -PassThru
# $api::SHRegEnumUSKeyW(hUSKey, dwIndex, pwzName, pcchName, enumRegFlags)

#uselib "SHLWAPI.dll"
#func global SHRegEnumUSKeyW "SHRegEnumUSKeyW" wptr, wptr, wptr, wptr, wptr
; SHRegEnumUSKeyW hUSKey, dwIndex, varptr(pwzName), varptr(pcchName), enumRegFlags   ; 戻り値は stat
; hUSKey : INT_PTR -> "wptr"
; dwIndex : DWORD -> "wptr"
; pwzName : LPWSTR out -> "wptr"
; pcchName : DWORD* in/out -> "wptr"
; enumRegFlags : SHREGENUM_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegEnumUSKeyW "SHRegEnumUSKeyW" sptr, int, var, var, int
; res = SHRegEnumUSKeyW(hUSKey, dwIndex, pwzName, pcchName, enumRegFlags)
; hUSKey : INT_PTR -> "sptr"
; dwIndex : DWORD -> "int"
; pwzName : LPWSTR out -> "var"
; pcchName : DWORD* in/out -> "var"
; enumRegFlags : SHREGENUM_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHRegEnumUSKeyW "SHRegEnumUSKeyW" sptr, int, sptr, sptr, int
; res = SHRegEnumUSKeyW(hUSKey, dwIndex, varptr(pwzName), varptr(pcchName), enumRegFlags)
; hUSKey : INT_PTR -> "sptr"
; dwIndex : DWORD -> "int"
; pwzName : LPWSTR out -> "sptr"
; pcchName : DWORD* in/out -> "sptr"
; enumRegFlags : SHREGENUM_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。