ホーム › UI.Shell › SHRegGetValueFromHKCUHKLM

SHRegGetValueFromHKCUHKLM

関数

HKCUを優先しなければHKLMからレジストリの値を取得する。

DLLSHLWAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// SHLWAPI.dll
#include <windows.h>

WIN32_ERROR SHRegGetValueFromHKCUHKLM(
    LPCWSTR pwszKey,
    LPCWSTR pwszValue,   // optional
    INT srrfFlags,
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

パラメーター

名前	型	方向	説明
pwszKey	LPCWSTR	in	レジストリキーへのパスを指定する、null で終わる Unicode 文字列へのポインターです。
pwszValue	LPCWSTR	inoptional	キーの値を指定する、null で終わる Unicode 文字列へのポインターです。この値は NULL にすることができ、その場合はデフォルト値からデータが取得されます。
srrfFlags	INT	in	SRRF フラグ定数です。複数のフラグを使用する場合は、ビット単位の OR で組み合わせることができます。これらのフラグは、返されるデータの型を制限するために使用します。この値を 0 にすることはできません。
pdwType	DWORD*	outoptional	この関数が返るときに、指定された値に格納されているデータの型を示すコードを受け取る DWORD へのポインターを格納します。型情報が不要な場合は NULL を設定できます。この値が NULL ではなく、かつ SRRF_NOEXPAND フラグが設定されていない場合、REG_EXPAND_SZ のデータ型はこのメソッド内で自動的に展開されるため、REG_SZ として返されます。
pvData	void*	outoptional	値のデータを格納するバッファーへのポインターです。データが不要な場合、このパラメーターは NULL にすることができます。この値には、入力時に pvData バッファーのサイズを格納しておく必要があります。pvData が NULL の場合（または pvData が NULL ではないがレジストリデータを保持するにはバッファーが小さすぎる場合）、戻り時にはレジストリデータの保持に必要なサイズが格納されます。
pcbData	DWORD*	inoutoptional	この関数が返るときに、データのサイズ（バイト単位）へのポインターを格納します。

戻り値の型: WIN32_ERROR

公式ドキュメント

レジストリから指定された情報を取得します。

戻り値

型: LONG

成功した場合、この関数は ERROR_SUCCESS と、要求されたすべての出力パラメーターを返します。NULL 以外で指定された pvData の領域が不足して関数が失敗した場合は、ERROR_MORE_DATA を返します。この場合、有効なデータを含む可能性があるのは pdwType と pcbData のみで、pvData は未定義となります。それ以外の場合は、Winerror.h で定義されている 0 以外のエラーコードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll
#include <windows.h>

WIN32_ERROR SHRegGetValueFromHKCUHKLM(
    LPCWSTR pwszKey,
    LPCWSTR pwszValue,   // optional
    INT srrfFlags,
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern uint SHRegGetValueFromHKCUHKLM(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszKey,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pwszValue,   // LPCWSTR optional
    int srrfFlags,   // INT
    IntPtr pdwType,   // DWORD* optional, out
    IntPtr pvData,   // void* optional, out
    IntPtr pcbData   // DWORD* optional, in/out
);

<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHRegGetValueFromHKCUHKLM(
    <MarshalAs(UnmanagedType.LPWStr)> pwszKey As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwszValue As String,   ' LPCWSTR optional
    srrfFlags As Integer,   ' INT
    pdwType As IntPtr,   ' DWORD* optional, out
    pvData As IntPtr,   ' void* optional, out
    pcbData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' pwszKey : LPCWSTR
' pwszValue : LPCWSTR optional
' srrfFlags : INT
' pdwType : DWORD* optional, out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
Declare PtrSafe Function SHRegGetValueFromHKCUHKLM Lib "shlwapi" ( _
    ByVal pwszKey As LongPtr, _
    ByVal pwszValue As LongPtr, _
    ByVal srrfFlags As Long, _
    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

SHRegGetValueFromHKCUHKLM = ctypes.windll.shlwapi.SHRegGetValueFromHKCUHKLM
SHRegGetValueFromHKCUHKLM.restype = wintypes.DWORD
SHRegGetValueFromHKCUHKLM.argtypes = [
    wintypes.LPCWSTR,  # pwszKey : LPCWSTR
    wintypes.LPCWSTR,  # pwszValue : LPCWSTR optional
    ctypes.c_int,  # srrfFlags : INT
    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')
SHRegGetValueFromHKCUHKLM = Fiddle::Function.new(
  lib['SHRegGetValueFromHKCUHKLM'],
  [
    Fiddle::TYPE_VOIDP,  # pwszKey : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pwszValue : LPCWSTR optional
    Fiddle::TYPE_INT,  # srrfFlags : INT
    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 SHRegGetValueFromHKCUHKLM(
        pwszKey: *const u16,  // LPCWSTR
        pwszValue: *const u16,  // LPCWSTR optional
        srrfFlags: i32,  // INT
        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")]
public static extern uint SHRegGetValueFromHKCUHKLM([MarshalAs(UnmanagedType.LPWStr)] string pwszKey, [MarshalAs(UnmanagedType.LPWStr)] string pwszValue, int srrfFlags, IntPtr pdwType, IntPtr pvData, IntPtr pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetValueFromHKCUHKLM' -Namespace Win32 -PassThru
# $api::SHRegGetValueFromHKCUHKLM(pwszKey, pwszValue, srrfFlags, pdwType, pvData, pcbData)

#uselib "SHLWAPI.dll"
#func global SHRegGetValueFromHKCUHKLM "SHRegGetValueFromHKCUHKLM" sptr, sptr, sptr, sptr, sptr, sptr
; SHRegGetValueFromHKCUHKLM pwszKey, pwszValue, srrfFlags, varptr(pdwType), pvData, varptr(pcbData)   ; 戻り値は stat
; pwszKey : LPCWSTR -> "sptr"
; pwszValue : LPCWSTR optional -> "sptr"
; srrfFlags : INT -> "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 SHRegGetValueFromHKCUHKLM "SHRegGetValueFromHKCUHKLM" wstr, wstr, int, var, sptr, var
; res = SHRegGetValueFromHKCUHKLM(pwszKey, pwszValue, srrfFlags, pdwType, pvData, pcbData)
; pwszKey : LPCWSTR -> "wstr"
; pwszValue : LPCWSTR optional -> "wstr"
; srrfFlags : INT -> "int"
; pdwType : DWORD* optional, out -> "var"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHRegGetValueFromHKCUHKLM "SHRegGetValueFromHKCUHKLM" wstr, wstr, int, sptr, sptr, sptr
; res = SHRegGetValueFromHKCUHKLM(pwszKey, pwszValue, srrfFlags, varptr(pdwType), pvData, varptr(pcbData))
; pwszKey : LPCWSTR -> "wstr"
; pwszValue : LPCWSTR optional -> "wstr"
; srrfFlags : INT -> "int"
; pdwType : DWORD* optional, out -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。