ホーム › UI.Shell › SHRegEnumUSValueA

SHRegEnumUSValueA

関数

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

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

シグネチャ

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

WIN32_ERROR SHRegEnumUSValueA(
    INT_PTR hUSkey,
    DWORD dwIndex,
    LPSTR pszValueName,
    DWORD* pcchValueName,
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData,   // optional
    SHREGENUM_FLAGS enumRegFlags
);

パラメーター

名前	型	方向	説明
hUSkey	INT_PTR	in	現在開かれているレジストリサブキーへのハンドル。このサブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、Registry Key Security and Access Rights を参照してください。このハンドルは SHRegOpenUSKey 関数を通じて取得できます。
dwIndex	DWORD	in	取得する値のインデックス。このパラメーターは最初の呼び出しではゼロにし、以降の呼び出しごとにインクリメントします。
pszValueName	LPSTR	out	列挙された値の名前を受け取る文字バッファーへのポインター。このバッファーのサイズは pcchValueNameLen で指定します。
pcchValueName	DWORD*	inout	入力時には pszValueName のバッファーのサイズ(文字数)を格納する DWORD へのポインター。出力時には pszValueName にコピーされた文字数が格納されます。
pdwType	DWORD*	outoptional	値のデータ型を受け取る DWORD へのポインター。これらは RegEnumValue の lpType パラメーターで説明されている値と同じです。
pvData	void*	outoptional	値エントリのデータを受け取るバッファーへのポインター。このバッファーのサイズは pcbData で指定します。データが不要な場合、このパラメーターは NULL にできます。
pcbData	DWORD*	inoutoptional	入力時には pvData のバッファーのサイズを格納する DWORD へのポインター。出力時には pvData にコピーされたバイト数が格納されます。
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 版を自動的に選択するエイリアスとして SHRegEnumUSValue を定義します。エンコーディングニュートラルなエイリアスの使用を、エンコーディングニュートラルでないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHRegEnumUSValueA(
    INT_PTR hUSkey,
    DWORD dwIndex,
    LPSTR pszValueName,
    DWORD* pcchValueName,
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData,   // optional
    SHREGENUM_FLAGS enumRegFlags
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegEnumUSValueA(
    IntPtr hUSkey,   // INT_PTR
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszValueName,   // LPSTR out
    ref uint pcchValueName,   // DWORD* in/out
    IntPtr pdwType,   // DWORD* optional, out
    IntPtr pvData,   // void* optional, out
    IntPtr pcbData,   // DWORD* optional, in/out
    int enumRegFlags   // SHREGENUM_FLAGS
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegEnumUSValueA(
    hUSkey As IntPtr,   ' INT_PTR
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszValueName As System.Text.StringBuilder,   ' LPSTR out
    ByRef pcchValueName As UInteger,   ' DWORD* in/out
    pdwType As IntPtr,   ' DWORD* optional, out
    pvData As IntPtr,   ' void* optional, out
    pcbData As IntPtr,   ' DWORD* optional, in/out
    enumRegFlags As Integer   ' SHREGENUM_FLAGS
) As UInteger
End Function

' hUSkey : INT_PTR
' dwIndex : DWORD
' pszValueName : LPSTR out
' pcchValueName : DWORD* in/out
' pdwType : DWORD* optional, out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
' enumRegFlags : SHREGENUM_FLAGS
Declare PtrSafe Function SHRegEnumUSValueA Lib "shlwapi" ( _
    ByVal hUSkey As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal pszValueName As String, _
    ByRef pcchValueName As Long, _
    ByVal pdwType As LongPtr, _
    ByVal pvData As LongPtr, _
    ByVal pcbData As LongPtr, _
    ByVal enumRegFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegEnumUSValueA = ctypes.windll.shlwapi.SHRegEnumUSValueA
SHRegEnumUSValueA.restype = wintypes.DWORD
SHRegEnumUSValueA.argtypes = [
    ctypes.c_ssize_t,  # hUSkey : INT_PTR
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPSTR,  # pszValueName : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchValueName : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwType : DWORD* optional, out
    ctypes.POINTER(None),  # pvData : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbData : DWORD* optional, in/out
    ctypes.c_int,  # enumRegFlags : SHREGENUM_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegEnumUSValueA = Fiddle::Function.new(
  lib['SHRegEnumUSValueA'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSkey : INT_PTR
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pszValueName : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchValueName : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pdwType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pvData : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbData : DWORD* optional, in/out
    Fiddle::TYPE_INT,  # enumRegFlags : SHREGENUM_FLAGS
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegEnumUSValueA(
        hUSkey: isize,  // INT_PTR
        dwIndex: u32,  // DWORD
        pszValueName: *mut u8,  // LPSTR out
        pcchValueName: *mut u32,  // DWORD* in/out
        pdwType: *mut u32,  // DWORD* optional, out
        pvData: *mut (),  // void* optional, out
        pcbData: *mut u32,  // DWORD* optional, 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 SHRegEnumUSValueA(IntPtr hUSkey, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszValueName, ref uint pcchValueName, IntPtr pdwType, IntPtr pvData, IntPtr pcbData, int enumRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegEnumUSValueA' -Namespace Win32 -PassThru
# $api::SHRegEnumUSValueA(hUSkey, dwIndex, pszValueName, pcchValueName, pdwType, pvData, pcbData, enumRegFlags)

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

出力引数:

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