ホーム › UI.Shell › SHRegGetUSValueA

SHRegGetUSValueA

関数

ユーザー単位レジストリのサブキーと値名から値を取得する。

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

シグネチャ

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

WIN32_ERROR SHRegGetUSValueA(
    LPCSTR pszSubKey,
    LPCSTR pszValue,   // optional
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData,   // optional
    BOOL fIgnoreHKCU,
    void* pvDefaultData,   // optional
    DWORD dwDefaultDataSize
);

パラメーター

名前	型	方向
pszSubKey	LPCSTR	in
pszValue	LPCSTR	inoptional
pdwType	DWORD*	inoutoptional
pvData	void*	outoptional
pcbData	DWORD*	inoutoptional
fIgnoreHKCU	BOOL	in
pvDefaultData	void*	inoptional
dwDefaultDataSize	DWORD	in

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR SHRegGetUSValueA(
    LPCSTR pszSubKey,
    LPCSTR pszValue,   // optional
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData,   // optional
    BOOL fIgnoreHKCU,
    void* pvDefaultData,   // optional
    DWORD dwDefaultDataSize
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegGetUSValueA(
    [MarshalAs(UnmanagedType.LPStr)] string pszSubKey,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszValue,   // LPCSTR optional
    IntPtr pdwType,   // DWORD* optional, in/out
    IntPtr pvData,   // void* optional, out
    IntPtr pcbData,   // DWORD* optional, in/out
    bool fIgnoreHKCU,   // BOOL
    IntPtr pvDefaultData,   // void* optional
    uint dwDefaultDataSize   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegGetUSValueA(
    <MarshalAs(UnmanagedType.LPStr)> pszSubKey As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszValue As String,   ' LPCSTR optional
    pdwType As IntPtr,   ' DWORD* optional, in/out
    pvData As IntPtr,   ' void* optional, out
    pcbData As IntPtr,   ' DWORD* optional, in/out
    fIgnoreHKCU As Boolean,   ' BOOL
    pvDefaultData As IntPtr,   ' void* optional
    dwDefaultDataSize As UInteger   ' DWORD
) As UInteger
End Function

' pszSubKey : LPCSTR
' pszValue : LPCSTR optional
' pdwType : DWORD* optional, in/out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
' fIgnoreHKCU : BOOL
' pvDefaultData : void* optional
' dwDefaultDataSize : DWORD
Declare PtrSafe Function SHRegGetUSValueA Lib "shlwapi" ( _
    ByVal pszSubKey As String, _
    ByVal pszValue As String, _
    ByVal pdwType As LongPtr, _
    ByVal pvData As LongPtr, _
    ByVal pcbData As LongPtr, _
    ByVal fIgnoreHKCU As Long, _
    ByVal pvDefaultData As LongPtr, _
    ByVal dwDefaultDataSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegGetUSValueA = ctypes.windll.shlwapi.SHRegGetUSValueA
SHRegGetUSValueA.restype = wintypes.DWORD
SHRegGetUSValueA.argtypes = [
    wintypes.LPCSTR,  # pszSubKey : LPCSTR
    wintypes.LPCSTR,  # pszValue : LPCSTR optional
    ctypes.POINTER(wintypes.DWORD),  # pdwType : DWORD* optional, in/out
    ctypes.POINTER(None),  # pvData : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbData : DWORD* optional, in/out
    wintypes.BOOL,  # fIgnoreHKCU : BOOL
    ctypes.POINTER(None),  # pvDefaultData : void* optional
    wintypes.DWORD,  # dwDefaultDataSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegGetUSValueA = Fiddle::Function.new(
  lib['SHRegGetUSValueA'],
  [
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszValue : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pdwType : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pvData : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbData : DWORD* optional, in/out
    Fiddle::TYPE_INT,  # fIgnoreHKCU : BOOL
    Fiddle::TYPE_VOIDP,  # pvDefaultData : void* optional
    -Fiddle::TYPE_INT,  # dwDefaultDataSize : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetUSValueA(
        pszSubKey: *const u8,  // LPCSTR
        pszValue: *const u8,  // LPCSTR optional
        pdwType: *mut u32,  // DWORD* optional, in/out
        pvData: *mut (),  // void* optional, out
        pcbData: *mut u32,  // DWORD* optional, in/out
        fIgnoreHKCU: i32,  // BOOL
        pvDefaultData: *mut (),  // void* optional
        dwDefaultDataSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint SHRegGetUSValueA([MarshalAs(UnmanagedType.LPStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, IntPtr pdwType, IntPtr pvData, IntPtr pcbData, bool fIgnoreHKCU, IntPtr pvDefaultData, uint dwDefaultDataSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetUSValueA' -Namespace Win32 -PassThru
# $api::SHRegGetUSValueA(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)

#uselib "SHLWAPI.dll"
#func global SHRegGetUSValueA "SHRegGetUSValueA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SHRegGetUSValueA pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize   ; 戻り値は stat
; pszSubKey : LPCSTR -> "sptr"
; pszValue : LPCSTR optional -> "sptr"
; pdwType : DWORD* optional, in/out -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "sptr"
; fIgnoreHKCU : BOOL -> "sptr"
; pvDefaultData : void* optional -> "sptr"
; dwDefaultDataSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueA "SHRegGetUSValueA" str, str, var, sptr, var, int, sptr, int
; res = SHRegGetUSValueA(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR optional -> "str"
; pdwType : DWORD* optional, in/out -> "var"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "var"
; fIgnoreHKCU : BOOL -> "int"
; pvDefaultData : void* optional -> "sptr"
; dwDefaultDataSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueA "SHRegGetUSValueA" str, str, sptr, sptr, sptr, int, sptr, int
; res = SHRegGetUSValueA(pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR optional -> "str"
; pdwType : DWORD* optional, in/out -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "sptr"
; fIgnoreHKCU : BOOL -> "int"
; pvDefaultData : void* optional -> "sptr"
; dwDefaultDataSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; WIN32_ERROR SHRegGetUSValueA(LPCSTR pszSubKey, LPCSTR pszValue, DWORD* pdwType, void* pvData, DWORD* pcbData, BOOL fIgnoreHKCU, void* pvDefaultData, DWORD dwDefaultDataSize)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueA "SHRegGetUSValueA" str, str, var, intptr, var, int, intptr, int
; res = SHRegGetUSValueA(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR optional -> "str"
; pdwType : DWORD* optional, in/out -> "var"
; pvData : void* optional, out -> "intptr"
; pcbData : DWORD* optional, in/out -> "var"
; fIgnoreHKCU : BOOL -> "int"
; pvDefaultData : void* optional -> "intptr"
; dwDefaultDataSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR SHRegGetUSValueA(LPCSTR pszSubKey, LPCSTR pszValue, DWORD* pdwType, void* pvData, DWORD* pcbData, BOOL fIgnoreHKCU, void* pvDefaultData, DWORD dwDefaultDataSize)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueA "SHRegGetUSValueA" str, str, intptr, intptr, intptr, int, intptr, int
; res = SHRegGetUSValueA(pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR optional -> "str"
; pdwType : DWORD* optional, in/out -> "intptr"
; pvData : void* optional, out -> "intptr"
; pcbData : DWORD* optional, in/out -> "intptr"
; fIgnoreHKCU : BOOL -> "int"
; pvDefaultData : void* optional -> "intptr"
; dwDefaultDataSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegGetUSValueA = shlwapi.NewProc("SHRegGetUSValueA")
)

// pszSubKey (LPCSTR), pszValue (LPCSTR optional), pdwType (DWORD* optional, in/out), pvData (void* optional, out), pcbData (DWORD* optional, in/out), fIgnoreHKCU (BOOL), pvDefaultData (void* optional), dwDefaultDataSize (DWORD)
r1, _, err := procSHRegGetUSValueA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubKey))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
	uintptr(pdwType),
	uintptr(pvData),
	uintptr(pcbData),
	uintptr(fIgnoreHKCU),
	uintptr(pvDefaultData),
	uintptr(dwDefaultDataSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR

function SHRegGetUSValueA(
  pszSubKey: PAnsiChar;   // LPCSTR
  pszValue: PAnsiChar;   // LPCSTR optional
  pdwType: Pointer;   // DWORD* optional, in/out
  pvData: Pointer;   // void* optional, out
  pcbData: Pointer;   // DWORD* optional, in/out
  fIgnoreHKCU: BOOL;   // BOOL
  pvDefaultData: Pointer;   // void* optional
  dwDefaultDataSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetUSValueA';

result := DllCall("SHLWAPI\SHRegGetUSValueA"
    , "AStr", pszSubKey   ; LPCSTR
    , "AStr", pszValue   ; LPCSTR optional
    , "Ptr", pdwType   ; DWORD* optional, in/out
    , "Ptr", pvData   ; void* optional, out
    , "Ptr", pcbData   ; DWORD* optional, in/out
    , "Int", fIgnoreHKCU   ; BOOL
    , "Ptr", pvDefaultData   ; void* optional
    , "UInt", dwDefaultDataSize   ; DWORD
    , "UInt")   ; return: WIN32_ERROR

●SHRegGetUSValueA(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize) = DLL("SHLWAPI.dll", "dword SHRegGetUSValueA(char*, char*, void*, void*, void*, bool, void*, dword)")
# 呼び出し: SHRegGetUSValueA(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
# pszSubKey : LPCSTR -> "char*"
# pszValue : LPCSTR optional -> "char*"
# pdwType : DWORD* optional, in/out -> "void*"
# pvData : void* optional, out -> "void*"
# pcbData : DWORD* optional, in/out -> "void*"
# fIgnoreHKCU : BOOL -> "bool"
# pvDefaultData : void* optional -> "void*"
# dwDefaultDataSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。