Win32 API 日本語リファレンス
ホームUI.Shell › SHQueryValueExA

SHQueryValueExA

関数
開いたキーから値を取得し環境変数も展開する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHQueryValueExA(
    HKEY hkey,
    LPCSTR pszValue,   // optional
    DWORD* pdwReserved,   // optional
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

パラメーター

名前方向
hkeyHKEYin
pszValueLPCSTRinoptional
pdwReservedDWORD*optional
pdwTypeDWORD*outoptional
pvDatavoid*outoptional
pcbDataDWORD*inoutoptional

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR SHQueryValueExA(
    HKEY hkey,
    LPCSTR pszValue,   // optional
    DWORD* pdwReserved,   // optional
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHQueryValueExA(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string pszValue,   // LPCSTR optional
    IntPtr pdwReserved,   // DWORD* optional
    IntPtr pdwType,   // DWORD* optional, out
    IntPtr pvData,   // void* optional, out
    IntPtr pcbData   // DWORD* optional, in/out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHQueryValueExA(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> pszValue As String,   ' LPCSTR optional
    pdwReserved As IntPtr,   ' DWORD* optional
    pdwType As IntPtr,   ' DWORD* optional, out
    pvData As IntPtr,   ' void* optional, out
    pcbData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function
' hkey : HKEY
' pszValue : LPCSTR optional
' pdwReserved : DWORD* optional
' pdwType : DWORD* optional, out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
Declare PtrSafe Function SHQueryValueExA Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pszValue As String, _
    ByVal pdwReserved As LongPtr, _
    ByVal pdwType As LongPtr, _
    ByVal pvData As LongPtr, _
    ByVal pcbData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHQueryValueExA = ctypes.windll.shlwapi.SHQueryValueExA
SHQueryValueExA.restype = wintypes.DWORD
SHQueryValueExA.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCSTR,  # pszValue : LPCSTR optional
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    ctypes.POINTER(wintypes.DWORD),  # pdwType : DWORD* optional, out
    ctypes.POINTER(None),  # pvData : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbData : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHQueryValueExA = Fiddle::Function.new(
  lib['SHQueryValueExA'],
  [
    Fiddle::TYPE_VOIDP,  # hkey : HKEY
    Fiddle::TYPE_VOIDP,  # pszValue : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    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)
#[link(name = "shlwapi")]
extern "system" {
    fn SHQueryValueExA(
        hkey: *mut core::ffi::c_void,  // HKEY
        pszValue: *const u8,  // LPCSTR optional
        pdwReserved: *mut u32,  // DWORD* optional
        pdwType: *mut u32,  // DWORD* optional, out
        pvData: *mut (),  // void* optional, out
        pcbData: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint SHQueryValueExA(IntPtr hkey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, IntPtr pdwReserved, IntPtr pdwType, IntPtr pvData, IntPtr pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHQueryValueExA' -Namespace Win32 -PassThru
# $api::SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
#uselib "SHLWAPI.dll"
#func global SHQueryValueExA "SHQueryValueExA" sptr, sptr, sptr, sptr, sptr, sptr
; SHQueryValueExA hkey, pszValue, varptr(pdwReserved), varptr(pdwType), pvData, varptr(pcbData)   ; 戻り値は stat
; hkey : HKEY -> "sptr"
; pszValue : LPCSTR optional -> "sptr"
; pdwReserved : DWORD* optional -> "sptr"
; pdwType : DWORD* optional, out -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHQueryValueExA "SHQueryValueExA" sptr, str, var, var, sptr, var
; res = SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
; hkey : HKEY -> "sptr"
; pszValue : LPCSTR optional -> "str"
; pdwReserved : DWORD* optional -> "var"
; pdwType : DWORD* optional, out -> "var"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR SHQueryValueExA(HKEY hkey, LPCSTR pszValue, DWORD* pdwReserved, DWORD* pdwType, void* pvData, DWORD* pcbData)
#uselib "SHLWAPI.dll"
#cfunc global SHQueryValueExA "SHQueryValueExA" intptr, str, var, var, intptr, var
; res = SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
; hkey : HKEY -> "intptr"
; pszValue : LPCSTR optional -> "str"
; pdwReserved : DWORD* optional -> "var"
; pdwType : DWORD* optional, out -> "var"
; pvData : void* optional, out -> "intptr"
; pcbData : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHQueryValueExA = shlwapi.NewProc("SHQueryValueExA")
)

// hkey (HKEY), pszValue (LPCSTR optional), pdwReserved (DWORD* optional), pdwType (DWORD* optional, out), pvData (void* optional, out), pcbData (DWORD* optional, in/out)
r1, _, err := procSHQueryValueExA.Call(
	uintptr(hkey),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
	uintptr(pdwReserved),
	uintptr(pdwType),
	uintptr(pvData),
	uintptr(pcbData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SHQueryValueExA(
  hkey: THandle;   // HKEY
  pszValue: PAnsiChar;   // LPCSTR optional
  pdwReserved: Pointer;   // DWORD* optional
  pdwType: Pointer;   // DWORD* optional, out
  pvData: Pointer;   // void* optional, out
  pcbData: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHQueryValueExA';
result := DllCall("SHLWAPI\SHQueryValueExA"
    , "Ptr", hkey   ; HKEY
    , "AStr", pszValue   ; LPCSTR optional
    , "Ptr", pdwReserved   ; DWORD* optional
    , "Ptr", pdwType   ; DWORD* optional, out
    , "Ptr", pvData   ; void* optional, out
    , "Ptr", pcbData   ; DWORD* optional, in/out
    , "UInt")   ; return: WIN32_ERROR
●SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData) = DLL("SHLWAPI.dll", "dword SHQueryValueExA(void*, char*, void*, void*, void*, void*)")
# 呼び出し: SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
# hkey : HKEY -> "void*"
# pszValue : LPCSTR optional -> "char*"
# pdwReserved : DWORD* optional -> "void*"
# pdwType : DWORD* optional, out -> "void*"
# pvData : void* optional, out -> "void*"
# pcbData : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。