ホーム › UI.Shell › SHRegGetUSValueW

SHRegGetUSValueW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

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

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegGetUSValueW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubKey,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszValue,   // LPCWSTR 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.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegGetUSValueW(
    <MarshalAs(UnmanagedType.LPWStr)> pszSubKey As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszValue As String,   ' LPCWSTR 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 : LPCWSTR
' pszValue : LPCWSTR 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 SHRegGetUSValueW Lib "shlwapi" ( _
    ByVal pszSubKey As LongPtr, _
    ByVal pszValue As LongPtr, _
    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
' 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

SHRegGetUSValueW = ctypes.windll.shlwapi.SHRegGetUSValueW
SHRegGetUSValueW.restype = wintypes.DWORD
SHRegGetUSValueW.argtypes = [
    wintypes.LPCWSTR,  # pszSubKey : LPCWSTR
    wintypes.LPCWSTR,  # pszValue : LPCWSTR 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')
SHRegGetUSValueW = Fiddle::Function.new(
  lib['SHRegGetUSValueW'],
  [
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszValue : LPCWSTR 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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetUSValueW(
        pszSubKey: *const u16,  // LPCWSTR
        pszValue: *const u16,  // LPCWSTR 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.Unicode)]
public static extern uint SHRegGetUSValueW([MarshalAs(UnmanagedType.LPWStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPWStr)] string pszValue, IntPtr pdwType, IntPtr pvData, IntPtr pcbData, bool fIgnoreHKCU, IntPtr pvDefaultData, uint dwDefaultDataSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetUSValueW' -Namespace Win32 -PassThru
# $api::SHRegGetUSValueW(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)

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

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueW "SHRegGetUSValueW" wstr, wstr, var, sptr, var, int, sptr, int
; res = SHRegGetUSValueW(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCWSTR -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; 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 SHRegGetUSValueW "SHRegGetUSValueW" wstr, wstr, sptr, sptr, sptr, int, sptr, int
; res = SHRegGetUSValueW(pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCWSTR -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; 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 SHRegGetUSValueW(LPCWSTR pszSubKey, LPCWSTR pszValue, DWORD* pdwType, void* pvData, DWORD* pcbData, BOOL fIgnoreHKCU, void* pvDefaultData, DWORD dwDefaultDataSize)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueW "SHRegGetUSValueW" wstr, wstr, var, intptr, var, int, intptr, int
; res = SHRegGetUSValueW(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCWSTR -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; 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 SHRegGetUSValueW(LPCWSTR pszSubKey, LPCWSTR pszValue, DWORD* pdwType, void* pvData, DWORD* pcbData, BOOL fIgnoreHKCU, void* pvDefaultData, DWORD dwDefaultDataSize)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetUSValueW "SHRegGetUSValueW" wstr, wstr, intptr, intptr, intptr, int, intptr, int
; res = SHRegGetUSValueW(pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; pszSubKey : LPCWSTR -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; 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")
	procSHRegGetUSValueW = shlwapi.NewProc("SHRegGetUSValueW")
)

// pszSubKey (LPCWSTR), pszValue (LPCWSTR optional), pdwType (DWORD* optional, in/out), pvData (void* optional, out), pcbData (DWORD* optional, in/out), fIgnoreHKCU (BOOL), pvDefaultData (void* optional), dwDefaultDataSize (DWORD)
r1, _, err := procSHRegGetUSValueW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszSubKey))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(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 SHRegGetUSValueW(
  pszSubKey: PWideChar;   // LPCWSTR
  pszValue: PWideChar;   // LPCWSTR 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 'SHRegGetUSValueW';

result := DllCall("SHLWAPI\SHRegGetUSValueW"
    , "WStr", pszSubKey   ; LPCWSTR
    , "WStr", pszValue   ; LPCWSTR 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

●SHRegGetUSValueW(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize) = DLL("SHLWAPI.dll", "dword SHRegGetUSValueW(char*, char*, void*, void*, void*, bool, void*, dword)")
# 呼び出し: SHRegGetUSValueW(pszSubKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
# pszSubKey : LPCWSTR -> "char*"
# pszValue : LPCWSTR 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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。