SHRegEnumUSKeyA

関数

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

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

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR SHRegEnumUSKeyA(
    INT_PTR hUSKey,
    DWORD dwIndex,
    LPSTR pszName,
    DWORD* pcchName,
    SHREGENUM_FLAGS enumRegFlags
);

パラメーター

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

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

型: LSTATUS

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

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR SHRegEnumUSKeyA(
    INT_PTR hUSKey,
    DWORD dwIndex,
    LPSTR pszName,
    DWORD* pcchName,
    SHREGENUM_FLAGS enumRegFlags
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegEnumUSKeyA(
    IntPtr hUSKey,   // INT_PTR
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszName,   // LPSTR out
    ref uint pcchName,   // DWORD* in/out
    int enumRegFlags   // SHREGENUM_FLAGS
);

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

' hUSKey : INT_PTR
' dwIndex : DWORD
' pszName : LPSTR out
' pcchName : DWORD* in/out
' enumRegFlags : SHREGENUM_FLAGS
Declare PtrSafe Function SHRegEnumUSKeyA Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal pszName As String, _
    ByRef pcchName As Long, _
    ByVal enumRegFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegEnumUSKeyA = ctypes.windll.shlwapi.SHRegEnumUSKeyA
SHRegEnumUSKeyA.restype = wintypes.DWORD
SHRegEnumUSKeyA.argtypes = [
    ctypes.c_ssize_t,  # hUSKey : INT_PTR
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPSTR,  # pszName : LPSTR 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')
SHRegEnumUSKeyA = Fiddle::Function.new(
  lib['SHRegEnumUSKeyA'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSKey : INT_PTR
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pszName : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchName : DWORD* in/out
    Fiddle::TYPE_INT,  # enumRegFlags : SHREGENUM_FLAGS
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegEnumUSKeyA(
        hUSKey: isize,  // INT_PTR
        dwIndex: u32,  // DWORD
        pszName: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint SHRegEnumUSKeyA(IntPtr hUSKey, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszName, ref uint pcchName, int enumRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegEnumUSKeyA' -Namespace Win32 -PassThru
# $api::SHRegEnumUSKeyA(hUSKey, dwIndex, pszName, pcchName, enumRegFlags)

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

出力引数:

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