ホーム › UI.Shell › SHRegGetUSValueA

SHRegGetUSValueA

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
pszSubKey	LPCSTR	in	HKEY_LOCAL_MACHINE および HKEY_CURRENT_USER からの相対的なサブキー名を含む null 終端文字列へのポインター。例: "Software\MyCompany\MyProduct"。
pszValue	LPCSTR	inoptional	値の名前を含む null 終端文字列へのポインター。この値は NULL にできます。
pdwType	DWORD*	inoutoptional	取得した値に格納されているデータの型を受け取る DWORD へのポインター。既定値を使用する場合、入力の pdwType は既定値の型になります。指定できる値については、レジストリデータ型を参照してください。型情報が不要な場合、このパラメーターは NULL にできます。
pvData	void*	outoptional	値のデータを受け取るバッファーへのポインター。
pcbData	DWORD*	inoutoptional	pvData が指すバッファーのサイズ(バイト単位)を指定する変数へのポインター。SHRegGetUSValue が戻るとき、pcbData には pvData にコピーされたデータのサイズが格納されます。
fIgnoreHKCU	BOOL	in	どのキーを参照するかを指定する変数。TRUE に設定すると、SHRegGetUSValue は HKEY_CURRENT_USER を無視し、HKEY_LOCAL_MACHINE 配下のキーから値を返します。
pvDefaultData	void*	inoptional	値の既定データを受け取るバッファーへのポインター。
dwDefaultDataSize	DWORD	in	pvDefaultData が指すバッファーの長さ(バイト単位)。

戻り値の型: WIN32_ERROR

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内のレジストリサブキーから値を取得します。(ANSI)

戻り値

型: LSTATUS

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

解説(Remarks)

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

この関数は使用されるたびにキーを開きます。同じキーから一連の値を取得するコードの場合は、SHRegOpenUSKey でキーを 1 回だけ開き、その後 SHRegQueryUSValue を使用してデータを取得する方が効率的です。

メモ

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

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

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegGetUSValueA(
    [MarshalAs(UnmanagedType.LPStr)] string pszSubKey,   // LPCSTR
    [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
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegGetUSValueA(
    <MarshalAs(UnmanagedType.LPStr)> pszSubKey As String,   ' LPCSTR
    <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
) As UInteger
End Function

' pszSubKey : LPCSTR
' pszValue : LPCSTR 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 SHRegGetUSValueA Lib "shlwapi" ( _
    ByVal pszSubKey As String, _
    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

SHRegGetUSValueA = ctypes.windll.shlwapi.SHRegGetUSValueA
SHRegGetUSValueA.restype = wintypes.DWORD
SHRegGetUSValueA.argtypes = [
    wintypes.LPCSTR,  # pszSubKey : LPCSTR
    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
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegGetUSValueA = Fiddle::Function.new(
  lib['SHRegGetUSValueA'],
  [
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCSTR
    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
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetUSValueA(
        pszSubKey: *const u8,  // LPCSTR
        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
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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