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

現在開いているキーへのハンドル、または以下の定義済みの値のいずれか。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

pszValueLPCSTRinoptional照会する値の名前を含む null 終端文字列のアドレス。
pdwReservedDWORD*optional予約済み。NULL を指定する必要があります。
pdwTypeDWORD*outoptionalキーの値の型を受け取る変数のアドレス。詳細については、Registry Data Types を参照してください。
pvDatavoid*outoptional値のデータを受け取るバッファーのアドレス。データが不要な場合、このパラメーターには NULL を指定できます。
pcbDataDWORD*inoutoptionalpvData パラメーターが指すバッファーのサイズ(バイト単位)を指定する変数のアドレス。関数が戻るとき、この変数には pvData にコピーされたデータのサイズが格納されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

レジストリキーを開き、特定の値を照会します。(ANSI)

戻り値

型: DWORD

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

解説(Remarks)

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、SHQueryValueEx を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 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)。
const std = @import("std");

extern "shlwapi" fn SHQueryValueExA(
    hkey: ?*anyopaque, // HKEY
    pszValue: [*c]const u8, // LPCSTR optional
    pdwReserved: [*c]u32, // DWORD* optional
    pdwType: [*c]u32, // DWORD* optional, out
    pvData: ?*anyopaque, // void* optional, out
    pcbData: [*c]u32 // DWORD* optional, in/out
) callconv(std.os.windows.WINAPI) u32;
proc SHQueryValueExA(
    hkey: pointer,  # HKEY
    pszValue: cstring,  # LPCSTR optional
    pdwReserved: ptr uint32,  # DWORD* optional
    pdwType: ptr uint32,  # DWORD* optional, out
    pvData: pointer,  # void* optional, out
    pcbData: ptr uint32  # DWORD* optional, in/out
): uint32 {.importc: "SHQueryValueExA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
uint SHQueryValueExA(
    void* hkey,   // HKEY
    const(char)* pszValue,   // LPCSTR optional
    uint* pdwReserved,   // DWORD* optional
    uint* pdwType,   // DWORD* optional, out
    void* pvData,   // void* optional, out
    uint* pcbData   // DWORD* optional, in/out
);
ccall((:SHQueryValueExA, "SHLWAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Ptr{UInt32}, Ptr{UInt32}, Ptr{Cvoid}, Ptr{UInt32}),
      hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
# hkey : HKEY -> Ptr{Cvoid}
# pszValue : LPCSTR optional -> Cstring
# pdwReserved : DWORD* optional -> Ptr{UInt32}
# pdwType : DWORD* optional, out -> Ptr{UInt32}
# pvData : void* optional, out -> Ptr{Cvoid}
# pcbData : DWORD* optional, in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHQueryValueExA(
    void* hkey,
    const char* pszValue,
    uint32_t* pdwReserved,
    uint32_t* pdwType,
    void* pvData,
    uint32_t* pcbData);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
-- hkey : HKEY
-- pszValue : LPCSTR optional
-- pdwReserved : DWORD* optional
-- pdwType : DWORD* optional, out
-- pvData : void* optional, out
-- pcbData : DWORD* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHQueryValueExA = lib.func('__stdcall', 'SHQueryValueExA', 'uint32_t', ['void *', 'str', 'uint32_t *', 'uint32_t *', 'void *', 'uint32_t *']);
// SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
// hkey : HKEY -> 'void *'
// pszValue : LPCSTR optional -> 'str'
// pdwReserved : DWORD* optional -> 'uint32_t *'
// pdwType : DWORD* optional, out -> 'uint32_t *'
// pvData : void* optional, out -> 'void *'
// pcbData : DWORD* optional, in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHQueryValueExA: { parameters: ["pointer", "buffer", "pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData)
// hkey : HKEY -> "pointer"
// pszValue : LPCSTR optional -> "buffer"
// pdwReserved : DWORD* optional -> "pointer"
// pdwType : DWORD* optional, out -> "pointer"
// pvData : void* optional, out -> "pointer"
// pcbData : DWORD* optional, in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHQueryValueExA(
    void* hkey,
    const char* pszValue,
    uint32_t* pdwReserved,
    uint32_t* pdwType,
    void* pvData,
    uint32_t* pcbData);
C, "SHLWAPI.dll");
// $ffi->SHQueryValueExA(hkey, pszValue, pdwReserved, pdwType, pvData, pcbData);
// hkey : HKEY
// pszValue : LPCSTR optional
// pdwReserved : DWORD* optional
// pdwType : DWORD* optional, out
// pvData : void* optional, out
// pcbData : DWORD* optional, in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
    int SHQueryValueExA(
        Pointer hkey,   // HKEY
        String pszValue,   // LPCSTR optional
        IntByReference pdwReserved,   // DWORD* optional
        IntByReference pdwType,   // DWORD* optional, out
        Pointer pvData,   // void* optional, out
        IntByReference pcbData   // DWORD* optional, in/out
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHQueryValueExA = SHQueryValueExA(
    hkey : Void*,   # HKEY
    pszValue : UInt8*,   # LPCSTR optional
    pdwReserved : UInt32*,   # DWORD* optional
    pdwType : UInt32*,   # DWORD* optional, out
    pvData : Void*,   # void* optional, out
    pcbData : UInt32*   # DWORD* optional, in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHQueryValueExANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
typedef SHQueryValueExADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
final SHQueryValueExA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHQueryValueExANative, SHQueryValueExADart>('SHQueryValueExA');
// hkey : HKEY -> Pointer<Void>
// pszValue : LPCSTR optional -> Pointer<Utf8>
// pdwReserved : DWORD* optional -> Pointer<Uint32>
// pdwType : DWORD* optional, out -> Pointer<Uint32>
// pvData : void* optional, out -> Pointer<Void>
// pcbData : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHQueryValueExA"
  c_SHQueryValueExA :: Ptr () -> CString -> Ptr Word32 -> Ptr Word32 -> Ptr () -> Ptr Word32 -> IO Word32
-- hkey : HKEY -> Ptr ()
-- pszValue : LPCSTR optional -> CString
-- pdwReserved : DWORD* optional -> Ptr Word32
-- pdwType : DWORD* optional, out -> Ptr Word32
-- pvData : void* optional, out -> Ptr ()
-- pcbData : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shqueryvalueexa =
  foreign "SHQueryValueExA"
    ((ptr void) @-> string @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* hkey : HKEY -> (ptr void) *)
(* pszValue : LPCSTR optional -> string *)
(* pdwReserved : DWORD* optional -> (ptr uint32_t) *)
(* pdwType : DWORD* optional, out -> (ptr uint32_t) *)
(* pvData : void* optional, out -> (ptr void) *)
(* pcbData : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHQueryValueExA" shquery-value-ex-a :convention :stdcall) :uint32
  (hkey :pointer)   ; HKEY
  (psz-value :string)   ; LPCSTR optional
  (pdw-reserved :pointer)   ; DWORD* optional
  (pdw-type :pointer)   ; DWORD* optional, out
  (pv-data :pointer)   ; void* optional, out
  (pcb-data :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHQueryValueExA = Win32::API::More->new('SHLWAPI',
    'DWORD SHQueryValueExA(HANDLE hkey, LPCSTR pszValue, LPVOID pdwReserved, LPVOID pdwType, LPVOID pvData, LPVOID pcbData)');
# my $ret = $SHQueryValueExA->Call($hkey, $pszValue, $pdwReserved, $pdwType, $pvData, $pcbData);
# hkey : HKEY -> HANDLE
# pszValue : LPCSTR optional -> LPCSTR
# pdwReserved : DWORD* optional -> LPVOID
# pdwType : DWORD* optional, out -> LPVOID
# pvData : void* optional, out -> LPVOID
# pcbData : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型