SHRegGetValueW

関数

フラグ指定付きでレジストリの値を取得し型変換も行う。

DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SHRegGetValueW(
    HKEY hkey,
    LPCWSTR pszSubKey,   // optional
    LPCWSTR pszValue,   // optional
    INT srrfFlags,
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

パラメーター

名前

型

方向

説明

hkey

HKEY

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

HKEY_USERS

pszSubKey

LPCWSTR

inoptional

値を取得するサブキーまでの、hkey からの相対パスを指定する null 終端文字列へのポインター。このパラメーターには NULL または空文字列を指定でき、その場合はデータが hkey の場所から取得されます。

pszValue

LPCWSTR

inoptional

値の名前を含む null 終端文字列へのポインター。このパラメーターには NULL または空文字列を指定でき、その場合はデータが既定値 (Default) から取得されます。

srrfFlags

INT

取得するデータを制限する SRRF フラグの 1 つ以上。少なくとも 1 つの型制限 (SRRF_RT) 値を指定する必要があります。

pdwType

DWORD*

outoptional

取得した値に格納されているデータの型を受け取る DWORD へのポインター。既定値を使用する場合、入力時の pdwType は既定値の型です。指定可能な値については、レジストリのデータ型を参照してください。SRRF_NOEXPAND フラグが設定されていない場合、REG_EXPAND_SZ 型は自動的に展開され、REG_SZ として返されます。型情報が不要な場合、このパラメーターには NULL を指定できます。

pvData

void*

outoptional

値のデータを受け取るバッファーへのポインター。データが不要な場合、このパラメーターには NULL を指定できます。たとえば、値の存在のみをテストする場合は、具体的な値のデータは不要です。

pcbData

DWORD*

inoutoptional

呼び出し時に、宛先データバッファー pvData のサイズをバイト単位で含む DWORD へのポインター。この値は、pvData が NULL の場合に限り NULL にできます。終了時には、pcbData は以下のいずれかの値を指します。

pvData	戻り値	pcbData
NULL	ERROR_SUCCESS	レジストリデータを保持するのに十分なサイズ (バイト単位)。これは正確なサイズが保証されるものではなく、十分なサイズにすぎないことに注意してください。
Non-NULL	ERROR_SUCCESS	pvData に書き込まれた正確なバイト数。
Non-NULL	ERROR_MORE_DATA	データ全体を保持するのに必要なサイズ (バイト単位)。これは正確なサイズが保証されるものではなく、十分なサイズにすぎないことに注意してください。

- hkey.HKEY_CLASSES_ROOT

- hkey.HKEY_CURRENT_CONFIG

- hkey.HKEY_CURRENT_USER

- hkey.HKEY_LOCAL_MACHINE

- hkey.HKEY_PERFORMANCE_DATA

- hkey.HKEY_USERS

戻り値の型: WIN32_ERROR

公式ドキュメント

レジストリ値を取得します。(SHRegGetValueW)

戻り値

型: LSTATUS

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

解説(Remarks)

SHRegGetValue は、データ型のチェック、ブートモードのチェック、REG_EXPAND_SZ データの自動展開、および REG_SZ、REG_EXPAND_SZ、REG_MULTI_SZ データの null 終端の保証を提供します。

hkey で識別されるキーは、KEY_QUERY_VALUE セキュリティアクセスで開かれている必要があります。pszSubKey が NULL または空文字列でない場合、そのキーも現在の呼び出しコンテキストで KEY_QUERY_VALUE セキュリティアクセスで開ける必要があります。

データの型が REG_SZ、REG_EXPAND_SZ、または REG_MULTI_SZ の場合、返されるデータには文字列の null 終端が含まれるか、それを考慮したものになります。たとえば、pvData が NULL でない場合、そのバッファーに返されるデータは null 終端されます。pcbData が NULL でない場合、それが指すバッファーサイズには、終端の null 文字を保持するのに必要なバイト数が含まれます。

SRRF_NOEXPAND フラグが設定されていない限り、REG_EXPAND_SZ 型の文字列データは返される前に自動的に展開されます。展開された文字列の型は pdwType に REG_SZ として報告され、pcbData パラメーターは展開された文字列に対して書き込まれたバイト数を指し、pvData が指すバッファーには文字列の展開後のバージョンが格納されます。

パフォーマンスに関する注意

pszSubKey が NULL または空文字列でない場合、そのキーはアクセスのたびにこの関数によって開かれ、閉じられます。アプリケーションが同じサブキーから一連の値を取得する必要がある場合は、SHRegGetValue を呼び出す前に RegOpenKeyEx を使用してキーを開くことで、パフォーマンスが向上します。RegOpenKeyEx の phkResult パラメーターで返されたキーを、この関数の hkey パラメーターとして使用し、pszSubKey を NULL に設定してください。

データ型が REG_EXPAND_SZ で SRRF_NOEXPAND フラグが設定されていない場合、データを読み取るか再読み取りするためにレジストリへの追加呼び出しが発生する可能性があります。以下の条件によってその追加呼び出しが発生します。

pvData が NULL で、pcbData が NULL でない場合。データは取得されませんが、文字列を取得してそれを展開し、データバッファーに必要なサイズを判断するために、レジストリを読み取る必要があります。
pvData が NULL ではないが、データを保持するには小さすぎる場合。完全な文字列を取得するためにデータが再読み取りされ、文字列が展開され、必要な合計サイズが判断されます。

メモ

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

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

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SHRegGetValueW(
    HKEY hkey,
    LPCWSTR pszSubKey,   // optional
    LPCWSTR pszValue,   // optional
    INT srrfFlags,
    DWORD* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegGetValueW(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubKey,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszValue,   // LPCWSTR optional
    int srrfFlags,   // INT
    IntPtr pdwType,   // DWORD* optional, out
    IntPtr pvData,   // void* optional, out
    IntPtr pcbData   // DWORD* optional, in/out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegGetValueW(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> pszSubKey As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszValue 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

' hkey : HKEY
' pszSubKey : LPCWSTR optional
' pszValue : LPCWSTR optional
' srrfFlags : INT
' pdwType : DWORD* optional, out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
Declare PtrSafe Function SHRegGetValueW Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pszSubKey As LongPtr, _
    ByVal pszValue As LongPtr, _
    ByVal srrfFlags As Long, _
    ByVal pdwType As LongPtr, _
    ByVal pvData As LongPtr, _
    ByVal pcbData As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegGetValueW = ctypes.windll.shlwapi.SHRegGetValueW
SHRegGetValueW.restype = wintypes.DWORD
SHRegGetValueW.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCWSTR,  # pszSubKey : LPCWSTR optional
    wintypes.LPCWSTR,  # pszValue : 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')
SHRegGetValueW = Fiddle::Function.new(
  lib['SHRegGetValueW'],
  [
    Fiddle::TYPE_VOIDP,  # hkey : HKEY
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pszValue : 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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetValueW(
        hkey: *mut core::ffi::c_void,  // HKEY
        pszSubKey: *const u16,  // LPCWSTR optional
        pszValue: *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", CharSet = CharSet.Unicode)]
public static extern uint SHRegGetValueW(IntPtr hkey, [MarshalAs(UnmanagedType.LPWStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPWStr)] string pszValue, int srrfFlags, IntPtr pdwType, IntPtr pvData, IntPtr pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetValueW' -Namespace Win32 -PassThru
# $api::SHRegGetValueW(hkey, pszSubKey, pszValue, srrfFlags, pdwType, pvData, pcbData)

#uselib "SHLWAPI.dll"
#func global SHRegGetValueW "SHRegGetValueW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SHRegGetValueW hkey, pszSubKey, pszValue, srrfFlags, varptr(pdwType), pvData, varptr(pcbData)   ; 戻り値は stat
; hkey : HKEY -> "wptr"
; pszSubKey : LPCWSTR optional -> "wptr"
; pszValue : LPCWSTR optional -> "wptr"
; srrfFlags : INT -> "wptr"
; pdwType : DWORD* optional, out -> "wptr"
; pvData : void* optional, out -> "wptr"
; pcbData : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegGetValueW "SHRegGetValueW" sptr, wstr, wstr, int, var, sptr, var
; res = SHRegGetValueW(hkey, pszSubKey, pszValue, srrfFlags, pdwType, pvData, pcbData)
; hkey : HKEY -> "sptr"
; pszSubKey : LPCWSTR optional -> "wstr"
; pszValue : 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 SHRegGetValueW "SHRegGetValueW" sptr, wstr, wstr, int, sptr, sptr, sptr
; res = SHRegGetValueW(hkey, pszSubKey, pszValue, srrfFlags, varptr(pdwType), pvData, varptr(pcbData))
; hkey : HKEY -> "sptr"
; pszSubKey : LPCWSTR optional -> "wstr"
; pszValue : 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(変数))。