SHGetValueA
関数サブキーと値名を指定してレジストリの値を取得する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR SHGetValueA(
HKEY hkey,
LPCSTR pszSubKey, // optional
LPCSTR pszValue, // optional
DWORD* pdwType, // optional
void* pvData, // optional
DWORD* pcbData // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hkey | HKEY | in | 現在開いているキーへのハンドル、または次の定義済みの値のいずれか。 HKEY_CLASSES_ROOTHKEY_CURRENT_CONFIGHKEY_CURRENT_USERHKEY_LOCAL_MACHINEHKEY_PERFORMANCE_DATAHKEY_USERS |
| pszSubKey | LPCSTR | inoptional | 値を取得するサブキーの名前を指定する、null で終わる文字列のアドレス。 |
| pszValue | LPCSTR | inoptional | 値のアドレス。 |
| pdwType | DWORD* | outoptional | 値の型。詳細については、Registry Data Types を参照してください。 |
| pvData | void* | outoptional | 格納先データバッファーのアドレス。 |
| pcbData | DWORD* | inoutoptional | 格納先データバッファーのサイズ。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
レジストリ値を取得します。(SHGetValueA)
戻り値
型: LSTATUS
成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラーコードを返します。エラーの一般的な説明を取得するには、FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用できます。
解説(Remarks)
同じキー内の一連の値を設定または取得する必要がある場合は、この関数を繰り返し使用するよりも、キーを一度開いて通常の Microsoft Win32 レジストリ関数で値を設定または取得する方が適切です。
メモ
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHGetValue を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR SHGetValueA(
HKEY hkey,
LPCSTR pszSubKey, // optional
LPCSTR pszValue, // optional
DWORD* pdwType, // optional
void* pvData, // optional
DWORD* pcbData // optional
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHGetValueA(
IntPtr hkey, // HKEY
[MarshalAs(UnmanagedType.LPStr)] string pszSubKey, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string pszValue, // LPCSTR 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 SHGetValueA(
hkey As IntPtr, ' HKEY
<MarshalAs(UnmanagedType.LPStr)> pszSubKey As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> pszValue As String, ' LPCSTR 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
' pszSubKey : LPCSTR optional
' pszValue : LPCSTR optional
' pdwType : DWORD* optional, out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
Declare PtrSafe Function SHGetValueA Lib "shlwapi" ( _
ByVal hkey As LongPtr, _
ByVal pszSubKey As String, _
ByVal pszValue As String, _
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
SHGetValueA = ctypes.windll.shlwapi.SHGetValueA
SHGetValueA.restype = wintypes.DWORD
SHGetValueA.argtypes = [
wintypes.HANDLE, # hkey : HKEY
wintypes.LPCSTR, # pszSubKey : LPCSTR optional
wintypes.LPCSTR, # pszValue : LPCSTR 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')
SHGetValueA = Fiddle::Function.new(
lib['SHGetValueA'],
[
Fiddle::TYPE_VOIDP, # hkey : HKEY
Fiddle::TYPE_VOIDP, # pszSubKey : LPCSTR optional
Fiddle::TYPE_VOIDP, # pszValue : LPCSTR 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 SHGetValueA(
hkey: *mut core::ffi::c_void, // HKEY
pszSubKey: *const u8, // LPCSTR optional
pszValue: *const u8, // LPCSTR 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 SHGetValueA(IntPtr hkey, [MarshalAs(UnmanagedType.LPStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, IntPtr pdwType, IntPtr pvData, IntPtr pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHGetValueA' -Namespace Win32 -PassThru
# $api::SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData)#uselib "SHLWAPI.dll"
#func global SHGetValueA "SHGetValueA" sptr, sptr, sptr, sptr, sptr, sptr
; SHGetValueA hkey, pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData) ; 戻り値は stat
; hkey : HKEY -> "sptr"
; pszSubKey : LPCSTR optional -> "sptr"
; pszValue : LPCSTR 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 SHGetValueA "SHGetValueA" sptr, str, str, var, sptr, var ; res = SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData) ; hkey : HKEY -> "sptr" ; pszSubKey : LPCSTR optional -> "str" ; pszValue : LPCSTR optional -> "str" ; pdwType : DWORD* optional, out -> "var" ; pvData : void* optional, out -> "sptr" ; pcbData : DWORD* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global SHGetValueA "SHGetValueA" sptr, str, str, sptr, sptr, sptr ; res = SHGetValueA(hkey, pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData)) ; hkey : HKEY -> "sptr" ; pszSubKey : LPCSTR optional -> "str" ; pszValue : LPCSTR optional -> "str" ; pdwType : DWORD* optional, out -> "sptr" ; pvData : void* optional, out -> "sptr" ; pcbData : DWORD* optional, in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; WIN32_ERROR SHGetValueA(HKEY hkey, LPCSTR pszSubKey, LPCSTR pszValue, DWORD* pdwType, void* pvData, DWORD* pcbData) #uselib "SHLWAPI.dll" #cfunc global SHGetValueA "SHGetValueA" intptr, str, str, var, intptr, var ; res = SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData) ; hkey : HKEY -> "intptr" ; pszSubKey : LPCSTR optional -> "str" ; pszValue : LPCSTR optional -> "str" ; pdwType : DWORD* optional, out -> "var" ; pvData : void* optional, out -> "intptr" ; pcbData : DWORD* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR SHGetValueA(HKEY hkey, LPCSTR pszSubKey, LPCSTR pszValue, DWORD* pdwType, void* pvData, DWORD* pcbData) #uselib "SHLWAPI.dll" #cfunc global SHGetValueA "SHGetValueA" intptr, str, str, intptr, intptr, intptr ; res = SHGetValueA(hkey, pszSubKey, pszValue, varptr(pdwType), pvData, varptr(pcbData)) ; hkey : HKEY -> "intptr" ; pszSubKey : LPCSTR optional -> "str" ; pszValue : LPCSTR optional -> "str" ; pdwType : DWORD* optional, out -> "intptr" ; pvData : void* optional, out -> "intptr" ; pcbData : DWORD* optional, in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHGetValueA = shlwapi.NewProc("SHGetValueA")
)
// hkey (HKEY), pszSubKey (LPCSTR optional), pszValue (LPCSTR optional), pdwType (DWORD* optional, out), pvData (void* optional, out), pcbData (DWORD* optional, in/out)
r1, _, err := procSHGetValueA.Call(
uintptr(hkey),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubKey))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
uintptr(pdwType),
uintptr(pvData),
uintptr(pcbData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction SHGetValueA(
hkey: THandle; // HKEY
pszSubKey: PAnsiChar; // LPCSTR optional
pszValue: PAnsiChar; // LPCSTR optional
pdwType: Pointer; // DWORD* optional, out
pvData: Pointer; // void* optional, out
pcbData: Pointer // DWORD* optional, in/out
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHGetValueA';result := DllCall("SHLWAPI\SHGetValueA"
, "Ptr", hkey ; HKEY
, "AStr", pszSubKey ; LPCSTR optional
, "AStr", pszValue ; LPCSTR optional
, "Ptr", pdwType ; DWORD* optional, out
, "Ptr", pvData ; void* optional, out
, "Ptr", pcbData ; DWORD* optional, in/out
, "UInt") ; return: WIN32_ERROR●SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData) = DLL("SHLWAPI.dll", "dword SHGetValueA(void*, char*, char*, void*, void*, void*)")
# 呼び出し: SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData)
# hkey : HKEY -> "void*"
# pszSubKey : LPCSTR optional -> "char*"
# pszValue : LPCSTR optional -> "char*"
# 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 SHGetValueA(
hkey: ?*anyopaque, // HKEY
pszSubKey: [*c]const u8, // LPCSTR optional
pszValue: [*c]const u8, // LPCSTR 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 SHGetValueA(
hkey: pointer, # HKEY
pszSubKey: cstring, # LPCSTR optional
pszValue: cstring, # LPCSTR optional
pdwType: ptr uint32, # DWORD* optional, out
pvData: pointer, # void* optional, out
pcbData: ptr uint32 # DWORD* optional, in/out
): uint32 {.importc: "SHGetValueA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
uint SHGetValueA(
void* hkey, // HKEY
const(char)* pszSubKey, // LPCSTR optional
const(char)* pszValue, // LPCSTR optional
uint* pdwType, // DWORD* optional, out
void* pvData, // void* optional, out
uint* pcbData // DWORD* optional, in/out
);ccall((:SHGetValueA, "SHLWAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Cstring, Cstring, Ptr{UInt32}, Ptr{Cvoid}, Ptr{UInt32}),
hkey, pszSubKey, pszValue, pdwType, pvData, pcbData)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubKey : LPCSTR optional -> Cstring
# pszValue : LPCSTR optional -> Cstring
# 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 SHGetValueA(
void* hkey,
const char* pszSubKey,
const char* pszValue,
uint32_t* pdwType,
void* pvData,
uint32_t* pcbData);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData)
-- hkey : HKEY
-- pszSubKey : LPCSTR optional
-- pszValue : LPCSTR 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 SHGetValueA = lib.func('__stdcall', 'SHGetValueA', 'uint32_t', ['void *', 'str', 'str', 'uint32_t *', 'void *', 'uint32_t *']);
// SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData)
// hkey : HKEY -> 'void *'
// pszSubKey : LPCSTR optional -> 'str'
// pszValue : LPCSTR optional -> 'str'
// 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", {
SHGetValueA: { parameters: ["pointer", "buffer", "buffer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData)
// hkey : HKEY -> "pointer"
// pszSubKey : LPCSTR optional -> "buffer"
// pszValue : LPCSTR optional -> "buffer"
// 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 SHGetValueA(
void* hkey,
const char* pszSubKey,
const char* pszValue,
uint32_t* pdwType,
void* pvData,
uint32_t* pcbData);
C, "SHLWAPI.dll");
// $ffi->SHGetValueA(hkey, pszSubKey, pszValue, pdwType, pvData, pcbData);
// hkey : HKEY
// pszSubKey : LPCSTR optional
// pszValue : LPCSTR 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 SHGetValueA(
Pointer hkey, // HKEY
String pszSubKey, // LPCSTR optional
String pszValue, // LPCSTR optional
IntByReference pdwType, // DWORD* optional, out
Pointer pvData, // void* optional, out
IntByReference pcbData // DWORD* optional, in/out
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun SHGetValueA = SHGetValueA(
hkey : Void*, # HKEY
pszSubKey : UInt8*, # LPCSTR optional
pszValue : UInt8*, # LPCSTR 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 SHGetValueANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
typedef SHGetValueADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
final SHGetValueA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHGetValueANative, SHGetValueADart>('SHGetValueA');
// hkey : HKEY -> Pointer<Void>
// pszSubKey : LPCSTR optional -> Pointer<Utf8>
// pszValue : LPCSTR optional -> Pointer<Utf8>
// 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 SHGetValueA(
hkey: THandle; // HKEY
pszSubKey: PAnsiChar; // LPCSTR optional
pszValue: PAnsiChar; // LPCSTR optional
pdwType: Pointer; // DWORD* optional, out
pvData: Pointer; // void* optional, out
pcbData: Pointer // DWORD* optional, in/out
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHGetValueA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHGetValueA"
c_SHGetValueA :: Ptr () -> CString -> CString -> Ptr Word32 -> Ptr () -> Ptr Word32 -> IO Word32
-- hkey : HKEY -> Ptr ()
-- pszSubKey : LPCSTR optional -> CString
-- pszValue : LPCSTR optional -> CString
-- 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 shgetvaluea =
foreign "SHGetValueA"
((ptr void) @-> string @-> string @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* hkey : HKEY -> (ptr void) *)
(* pszSubKey : LPCSTR optional -> string *)
(* pszValue : LPCSTR optional -> string *)
(* 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 ("SHGetValueA" shget-value-a :convention :stdcall) :uint32
(hkey :pointer) ; HKEY
(psz-sub-key :string) ; LPCSTR optional
(psz-value :string) ; LPCSTR 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 $SHGetValueA = Win32::API::More->new('SHLWAPI',
'DWORD SHGetValueA(HANDLE hkey, LPCSTR pszSubKey, LPCSTR pszValue, LPVOID pdwType, LPVOID pvData, LPVOID pcbData)');
# my $ret = $SHGetValueA->Call($hkey, $pszSubKey, $pszValue, $pdwType, $pvData, $pcbData);
# hkey : HKEY -> HANDLE
# pszSubKey : LPCSTR optional -> LPCSTR
# pszValue : LPCSTR optional -> LPCSTR
# pdwType : DWORD* optional, out -> LPVOID
# pvData : void* optional, out -> LPVOID
# pcbData : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SHGetValueW (Unicode版) — サブキーと値名を指定してレジストリの値を取得する。
使用する型