ホーム › UI.Shell › SHRegQueryUSValueA

SHRegQueryUSValueA

関数

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

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

シグネチャ

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

WIN32_ERROR SHRegQueryUSValueA(
    INT_PTR hUSKey,
    LPCSTR pszValue,   // optional
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData,   // optional
    BOOL fIgnoreHKCU,
    void* pvDefaultData,   // optional
    DWORD dwDefaultDataSize   // optional
);

パラメーター

名前	型	方向	説明
hUSKey	INT_PTR	in	現在開いているレジストリサブキーへのハンドル、または以下の定義済みの値のいずれか。サブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。このハンドルは SHRegOpenUSKey 関数で取得できます。 HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_PERFORMANCE_DATA HKEY_USERS
pszValue	LPCSTR	inoptional	クエリ対象の値の名前を含む、null 終端文字列へのポインター。
pdwType	DWORD*	inoutoptional	キーの値の型を設定または受け取る変数へのポインター。詳細については、レジストリのデータ型を参照してください。このパラメーターは NULL にできます。
pvData	void*	outoptional	値のデータを受け取るバッファーへのポインター。データが不要な場合、このパラメーターは NULL にできます。
pcbData	DWORD*	inoutoptional	pvData パラメーターが指すバッファーのサイズ(バイト単位)を指定する変数へのポインター。関数が戻るとき、この変数には pvData へコピーされたデータのサイズが格納されます。
fIgnoreHKCU	BOOL	in	どのキーを参照するかを指定する変数。TRUE に設定すると、SHRegQueryUSValue は HKEY_CURRENT_USER を無視し、HKEY_LOCAL_MACHINE 下のキーから値を返します。
pvDefaultData	void*	inoptional	既定のデータへのポインター。
dwDefaultDataSize	DWORD	inoptional	既定のデータの長さ(バイト単位)。

戻り値の型: WIN32_ERROR

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内で、開いているレジストリサブキーに関連付けられた指定の名前について、その型とデータを取得します。(ANSI)

戻り値

型: LSTATUS

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

解説(Remarks)

fIgnoreHKCU が TRUE に設定されている場合、SHRegQueryUSValue は HKEY_LOCAL_MACHINE 下のキーから値を返します。FALSE に設定されている場合、SHRegQueryUSValue はまず HKEY_CURRENT_USER 下のキーから値を返そうとします。ただし、HKEY_CURRENT_USER 下にキーが見つからない場合は、HKEY_LOCAL_MACHINE 下のキーから値が返されます。いずれのキーも存在しない場合、またはエラーが発生し、かつ dwDefaultDataSize が 0 以外の場合は、既定のデータが pvData にコピーされ、ERROR_SUCCESS が返されます。ERROR_SUCCESS は既定のデータと既定以外のデータのどちらの場合でも返されるため、どちらの値が pvData にコピーされたかを区別する方法はありません。既定のデータの使用を防ぐには、pvDefaultData を NULL に、dwDefaultDataSize を 0 に設定してください。

単一の値を読み取るだけでよい場合は、SHRegGetUSValue がキーのオープンと値の返却の両方を行います。SHRegQueryUSValue を使用するには、まず SHRegOpenUSKey でキーを開く必要があります。ただし、キーをいったん開けば、必要なだけ SHRegQueryUSValue を使用できます。同じキーから複数の値を取得する必要がある場合は、キーが一度だけ開かれるため、SHRegQueryUSValue を複数回呼び出す方が通常 SHRegGetUSValue よりも効率的です。

メモ

shlwapi.h ヘッダーは、SHRegQueryUSValue をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHRegQueryUSValueA(
    INT_PTR hUSKey,
    LPCSTR pszValue,   // optional
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData,   // optional
    BOOL fIgnoreHKCU,
    void* pvDefaultData,   // optional
    DWORD dwDefaultDataSize   // optional
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegQueryUSValueA(
    IntPtr hUSKey,   // INT_PTR
    [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 optional
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegQueryUSValueA(
    hUSKey As IntPtr,   ' INT_PTR
    <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 optional
) As UInteger
End Function

' hUSKey : INT_PTR
' pszValue : LPCSTR optional
' pdwType : DWORD* optional, in/out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
' fIgnoreHKCU : BOOL
' pvDefaultData : void* optional
' dwDefaultDataSize : DWORD optional
Declare PtrSafe Function SHRegQueryUSValueA Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    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

SHRegQueryUSValueA = ctypes.windll.shlwapi.SHRegQueryUSValueA
SHRegQueryUSValueA.restype = wintypes.DWORD
SHRegQueryUSValueA.argtypes = [
    ctypes.c_ssize_t,  # hUSKey : INT_PTR
    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 optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegQueryUSValueA = Fiddle::Function.new(
  lib['SHRegQueryUSValueA'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSKey : INT_PTR
    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 optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegQueryUSValueA(
        hUSKey: isize,  // INT_PTR
        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 optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

#uselib "SHLWAPI.dll"
#func global SHRegQueryUSValueA "SHRegQueryUSValueA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SHRegQueryUSValueA hUSKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize   ; 戻り値は stat
; hUSKey : INT_PTR -> "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 optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegQueryUSValueA "SHRegQueryUSValueA" sptr, str, var, sptr, var, int, sptr, int
; res = SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; hUSKey : INT_PTR -> "sptr"
; 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 optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHRegQueryUSValueA "SHRegQueryUSValueA" sptr, str, sptr, sptr, sptr, int, sptr, int
; res = SHRegQueryUSValueA(hUSKey, pszValue, varptr(pdwType), pvData, varptr(pcbData), fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
; hUSKey : INT_PTR -> "sptr"
; 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 optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

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

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegQueryUSValueA = shlwapi.NewProc("SHRegQueryUSValueA")
)

// hUSKey (INT_PTR), pszValue (LPCSTR optional), pdwType (DWORD* optional, in/out), pvData (void* optional, out), pcbData (DWORD* optional, in/out), fIgnoreHKCU (BOOL), pvDefaultData (void* optional), dwDefaultDataSize (DWORD optional)
r1, _, err := procSHRegQueryUSValueA.Call(
	uintptr(hUSKey),
	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 SHRegQueryUSValueA(
  hUSKey: NativeInt;   // INT_PTR
  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 optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegQueryUSValueA';

result := DllCall("SHLWAPI\SHRegQueryUSValueA"
    , "Ptr", hUSKey   ; INT_PTR
    , "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 optional
    , "UInt")   ; return: WIN32_ERROR

●SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize) = DLL("SHLWAPI.dll", "dword SHRegQueryUSValueA(int, char*, void*, void*, void*, bool, void*, dword)")
# 呼び出し: SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
# hUSKey : INT_PTR -> "int"
# 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 optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "shlwapi" fn SHRegQueryUSValueA(
    hUSKey: isize, // INT_PTR
    pszValue: [*c]const u8, // LPCSTR optional
    pdwType: [*c]u32, // DWORD* optional, in/out
    pvData: ?*anyopaque, // void* optional, out
    pcbData: [*c]u32, // DWORD* optional, in/out
    fIgnoreHKCU: i32, // BOOL
    pvDefaultData: ?*anyopaque, // void* optional
    dwDefaultDataSize: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) u32;

proc SHRegQueryUSValueA(
    hUSKey: int,  # INT_PTR
    pszValue: cstring,  # LPCSTR optional
    pdwType: ptr uint32,  # DWORD* optional, in/out
    pvData: pointer,  # void* optional, out
    pcbData: ptr uint32,  # DWORD* optional, in/out
    fIgnoreHKCU: int32,  # BOOL
    pvDefaultData: pointer,  # void* optional
    dwDefaultDataSize: uint32  # DWORD optional
): uint32 {.importc: "SHRegQueryUSValueA", stdcall, dynlib: "SHLWAPI.dll".}

pragma(lib, "shlwapi");
extern(Windows)
uint SHRegQueryUSValueA(
    ptrdiff_t hUSKey,   // INT_PTR
    const(char)* pszValue,   // LPCSTR optional
    uint* pdwType,   // DWORD* optional, in/out
    void* pvData,   // void* optional, out
    uint* pcbData,   // DWORD* optional, in/out
    int fIgnoreHKCU,   // BOOL
    void* pvDefaultData,   // void* optional
    uint dwDefaultDataSize   // DWORD optional
);

ccall((:SHRegQueryUSValueA, "SHLWAPI.dll"), stdcall, UInt32,
      (Int, Cstring, Ptr{UInt32}, Ptr{Cvoid}, Ptr{UInt32}, Int32, Ptr{Cvoid}, UInt32),
      hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
# hUSKey : INT_PTR -> Int
# pszValue : LPCSTR optional -> Cstring
# pdwType : DWORD* optional, in/out -> Ptr{UInt32}
# pvData : void* optional, out -> Ptr{Cvoid}
# pcbData : DWORD* optional, in/out -> Ptr{UInt32}
# fIgnoreHKCU : BOOL -> Int32
# pvDefaultData : void* optional -> Ptr{Cvoid}
# dwDefaultDataSize : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegQueryUSValueA(
    intptr_t hUSKey,
    const char* pszValue,
    uint32_t* pdwType,
    void* pvData,
    uint32_t* pcbData,
    int32_t fIgnoreHKCU,
    void* pvDefaultData,
    uint32_t dwDefaultDataSize);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
-- hUSKey : INT_PTR
-- pszValue : LPCSTR optional
-- pdwType : DWORD* optional, in/out
-- pvData : void* optional, out
-- pcbData : DWORD* optional, in/out
-- fIgnoreHKCU : BOOL
-- pvDefaultData : void* optional
-- dwDefaultDataSize : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegQueryUSValueA = lib.func('__stdcall', 'SHRegQueryUSValueA', 'uint32_t', ['intptr_t', 'str', 'uint32_t *', 'void *', 'uint32_t *', 'int32_t', 'void *', 'uint32_t']);
// SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
// hUSKey : INT_PTR -> 'intptr_t'
// pszValue : LPCSTR optional -> 'str'
// pdwType : DWORD* optional, in/out -> 'uint32_t *'
// pvData : void* optional, out -> 'void *'
// pcbData : DWORD* optional, in/out -> 'uint32_t *'
// fIgnoreHKCU : BOOL -> 'int32_t'
// pvDefaultData : void* optional -> 'void *'
// dwDefaultDataSize : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegQueryUSValueA: { parameters: ["isize", "buffer", "pointer", "pointer", "pointer", "i32", "pointer", "u32"], result: "u32" },
});
// lib.symbols.SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize)
// hUSKey : INT_PTR -> "isize"
// pszValue : LPCSTR optional -> "buffer"
// pdwType : DWORD* optional, in/out -> "pointer"
// pvData : void* optional, out -> "pointer"
// pcbData : DWORD* optional, in/out -> "pointer"
// fIgnoreHKCU : BOOL -> "i32"
// pvDefaultData : void* optional -> "pointer"
// dwDefaultDataSize : DWORD optional -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t SHRegQueryUSValueA(
    intptr_t hUSKey,
    const char* pszValue,
    uint32_t* pdwType,
    void* pvData,
    uint32_t* pcbData,
    int32_t fIgnoreHKCU,
    void* pvDefaultData,
    uint32_t dwDefaultDataSize);
C, "SHLWAPI.dll");
// $ffi->SHRegQueryUSValueA(hUSKey, pszValue, pdwType, pvData, pcbData, fIgnoreHKCU, pvDefaultData, dwDefaultDataSize);
// hUSKey : INT_PTR
// pszValue : LPCSTR optional
// pdwType : DWORD* optional, in/out
// pvData : void* optional, out
// pcbData : DWORD* optional, in/out
// fIgnoreHKCU : BOOL
// pvDefaultData : void* optional
// dwDefaultDataSize : DWORD optional
// 構造体/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 SHRegQueryUSValueA(
        long hUSKey,   // INT_PTR
        String pszValue,   // LPCSTR optional
        IntByReference pdwType,   // DWORD* optional, in/out
        Pointer pvData,   // void* optional, out
        IntByReference pcbData,   // DWORD* optional, in/out
        boolean fIgnoreHKCU,   // BOOL
        Pointer pvDefaultData,   // void* optional
        int dwDefaultDataSize   // DWORD optional
    );
}

@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegQueryUSValueA = SHRegQueryUSValueA(
    hUSKey : LibC::SSizeT,   # INT_PTR
    pszValue : UInt8*,   # LPCSTR optional
    pdwType : UInt32*,   # DWORD* optional, in/out
    pvData : Void*,   # void* optional, out
    pcbData : UInt32*,   # DWORD* optional, in/out
    fIgnoreHKCU : Int32,   # BOOL
    pvDefaultData : Void*,   # void* optional
    dwDefaultDataSize : UInt32   # DWORD optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHRegQueryUSValueANative = Uint32 Function(IntPtr, Pointer<Utf8>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>, Int32, Pointer<Void>, Uint32);
typedef SHRegQueryUSValueADart = int Function(int, Pointer<Utf8>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>, int, Pointer<Void>, int);
final SHRegQueryUSValueA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegQueryUSValueANative, SHRegQueryUSValueADart>('SHRegQueryUSValueA');
// hUSKey : INT_PTR -> IntPtr
// pszValue : LPCSTR optional -> Pointer<Utf8>
// pdwType : DWORD* optional, in/out -> Pointer<Uint32>
// pvData : void* optional, out -> Pointer<Void>
// pcbData : DWORD* optional, in/out -> Pointer<Uint32>
// fIgnoreHKCU : BOOL -> Int32
// pvDefaultData : void* optional -> Pointer<Void>
// dwDefaultDataSize : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SHRegQueryUSValueA(
  hUSKey: NativeInt;   // INT_PTR
  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 optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegQueryUSValueA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHRegQueryUSValueA"
  c_SHRegQueryUSValueA :: CIntPtr -> CString -> Ptr Word32 -> Ptr () -> Ptr Word32 -> CInt -> Ptr () -> Word32 -> IO Word32
-- hUSKey : INT_PTR -> CIntPtr
-- pszValue : LPCSTR optional -> CString
-- pdwType : DWORD* optional, in/out -> Ptr Word32
-- pvData : void* optional, out -> Ptr ()
-- pcbData : DWORD* optional, in/out -> Ptr Word32
-- fIgnoreHKCU : BOOL -> CInt
-- pvDefaultData : void* optional -> Ptr ()
-- dwDefaultDataSize : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let shregqueryusvaluea =
  foreign "SHRegQueryUSValueA"
    (intptr_t @-> string @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint32_t) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pszValue : LPCSTR optional -> string *)
(* pdwType : DWORD* optional, in/out -> (ptr uint32_t) *)
(* pvData : void* optional, out -> (ptr void) *)
(* pcbData : DWORD* optional, in/out -> (ptr uint32_t) *)
(* fIgnoreHKCU : BOOL -> int32_t *)
(* pvDefaultData : void* optional -> (ptr void) *)
(* dwDefaultDataSize : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHRegQueryUSValueA" shreg-query-usvalue-a :convention :stdcall) :uint32
  (h-uskey :int64)   ; INT_PTR
  (psz-value :string)   ; LPCSTR optional
  (pdw-type :pointer)   ; DWORD* optional, in/out
  (pv-data :pointer)   ; void* optional, out
  (pcb-data :pointer)   ; DWORD* optional, in/out
  (f-ignore-hkcu :int32)   ; BOOL
  (pv-default-data :pointer)   ; void* optional
  (dw-default-data-size :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SHRegQueryUSValueA = Win32::API::More->new('SHLWAPI',
    'DWORD SHRegQueryUSValueA(LPARAM hUSKey, LPCSTR pszValue, LPVOID pdwType, LPVOID pvData, LPVOID pcbData, BOOL fIgnoreHKCU, LPVOID pvDefaultData, DWORD dwDefaultDataSize)');
# my $ret = $SHRegQueryUSValueA->Call($hUSKey, $pszValue, $pdwType, $pvData, $pcbData, $fIgnoreHKCU, $pvDefaultData, $dwDefaultDataSize);
# hUSKey : INT_PTR -> LPARAM
# pszValue : LPCSTR optional -> LPCSTR
# pdwType : DWORD* optional, in/out -> LPVOID
# pvData : void* optional, out -> LPVOID
# pcbData : DWORD* optional, in/out -> LPVOID
# fIgnoreHKCU : BOOL -> BOOL
# pvDefaultData : void* optional -> LPVOID
# dwDefaultDataSize : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

SHRegQueryUSValueA

シグネチャ

パラメーター

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目