RegGetValueA

関数

型チェック付きで指定したレジストリ値を取得する。

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

シグネチャ

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

WIN32_ERROR RegGetValueA(
    HKEY hkey,
    LPCSTR lpSubKey,   // optional
    LPCSTR lpValue,   // optional
    REG_ROUTINE_FLAGS dwFlags,
    REG_VALUE_TYPE* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

パラメーター

名前

型

方向

説明

hkey

HKEY

開いているレジストリキーへのハンドル。キーは KEY_QUERY_VALUE アクセス権で開かれている必要があります。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。

このハンドルは、 RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。また、次の定義済みキーのいずれかを指定することもできます。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_PERFORMANCE_NLSTEXT

HKEY_PERFORMANCE_TEXT

HKEY_USERS

lpSubKey

LPCSTR

inoptional

hkey パラメーターで指定されたキーからの相対的なレジストリキーのパス。レジストリ値はこのサブキーから取得されます。

パスは大文字と小文字を区別しません。

このパラメーターが NULL または空文字列 "" の場合、値は hkey で指定されたキー自体から読み取られます。

lpValue

LPCSTR

inoptional

レジストリ値の名前。

このパラメーターが NULL または空文字列 "" の場合、この関数はキーの名前のない値または既定値が存在すれば、その型とデータを取得します。キーは自動的に名前のない値または既定値を持つわけではなく、名前のない値は任意の型を取り得ます。

詳細については、レジストリ要素のサイズ制限を参照してください。

dwFlags

REG_ROUTINE_FLAGS

照会する値のデータ型を制限するフラグ。値のデータ型がこの条件を満たさない場合、関数は失敗します。このパラメーターには、次の値を 1 つ以上指定できます。

値	意味
RRF_RT_ANY 0x0000ffff	型の制限なし。
RRF_RT_DWORD 0x00000018	型を 32 ビットの RRF_RT_REG_BINARY \| RRF_RT_REG_DWORD に制限します。
RRF_RT_QWORD 0x00000048	型を 64 ビットの RRF_RT_REG_BINARY \| RRF_RT_REG_QWORD に制限します。
RRF_RT_REG_BINARY 0x00000008	型を REG_BINARY に制限します。
RRF_RT_REG_DWORD 0x00000010	型を REG_DWORD に制限します。
RRF_RT_REG_EXPAND_SZ 0x00000004	型を REG_EXPAND_SZ に制限します。
RRF_RT_REG_MULTI_SZ 0x00000020	型を REG_MULTI_SZ に制限します。
RRF_RT_REG_NONE 0x00000001	型を REG_NONE に制限します。
RRF_RT_REG_QWORD 0x00000040	型を REG_QWORD に制限します。
RRF_RT_REG_SZ 0x00000002	型を REG_SZ に制限します。

このパラメーターには、次の値を 1 つ以上含めることもできます。

値	意味
RRF_NOEXPAND 0x10000000	値の型が REG_EXPAND_SZ の場合でも、環境文字列を自動的に展開しません。
RRF_ZEROONFAILURE 0x20000000	pvData が NULL でない場合、失敗時にバッファーの内容をゼロに設定します。
RRF_SUBKEY_WOW6464KEY 0x00010000	lpSubKey が NULL でない場合、lpSubKey が指定するサブキーを KEY_WOW64_64KEY アクセス権で開きます。これらのアクセス権の詳細については、レジストリキーのセキュリティとアクセス権を参照してください。 RRF_SUBKEY_WOW6464KEY を RRF_SUBKEY_WOW6432KEY と組み合わせて指定することはできません。
RRF_SUBKEY_WOW6432KEY 0x00020000	lpSubKey が NULL でない場合、lpSubKey が指定するサブキーを KEY_WOW64_32KEY アクセス権で開きます。これらのアクセス権の詳細については、レジストリキーのセキュリティとアクセス権を参照してください。 RRF_SUBKEY_WOW6432KEY を RRF_SUBKEY_WOW6464KEY と組み合わせて指定することはできません。

pdwType

REG_VALUE_TYPE*

outoptional

指定された値に格納されているデータの型を示すコードを受け取る変数へのポインター。指定可能な型コードの一覧については、レジストリ値の型を参照してください。型が不要な場合、このパラメーターは NULL にできます。

pvData

void*

outoptional

値のデータを受け取るバッファーへのポインター。データが不要な場合、このパラメーターは NULL にできます。

データが文字列の場合、この関数は終端の null 文字があるかを確認します。見つからない場合、バッファーが余分な 1 文字を収容できる十分な大きさであれば、文字列は null 終端付きで格納されます。そうでない場合、関数は失敗し ERROR_MORE_DATA を返します。

pcbData

DWORD*

inoutoptional

pvData パラメーターが指すバッファーのサイズをバイト単位で指定する変数へのポインター。関数が戻るとき、この変数には pvData にコピーされたデータのサイズが格納されます。

pcbData パラメーターを NULL にできるのは、pvData が NULL の場合のみです。

データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、このサイズには終端の null 文字が含まれます。詳細については「解説」を参照してください。

pvData パラメーターで指定されたバッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを pcbData が指す変数に格納します。この場合、pvData バッファーの内容は、dwFlags に RRF_ZEROONFAILURE が指定されていればゼロになり、そうでなければ未定義です。

pvData が NULL で pcbData が非 NULL の場合、関数は ERROR_SUCCESS を返し、データのサイズをバイト単位で pcbData が指す変数に格納します。これにより、アプリケーションは値のデータ用に最適なバッファーの割り当て方法を判断できます。

hKey が HKEY_PERFORMANCE_DATA を指定し、pvData バッファーが返されるすべてのデータを格納できる大きさでない場合、関数は ERROR_MORE_DATA を返し、pcbData パラメーターを通じて返される値は未定義になります。これは、パフォーマンスデータのサイズが呼び出しごとに変化し得るためです。この場合、バッファーサイズを増やし、更新したバッファーサイズを pcbData パラメーターに渡して RegGetValue を再度呼び出す必要があります。関数が成功するまでこれを繰り返してください。pcbData が返す値は予測できないため、バッファーサイズを追跡するための別の変数を保持する必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたレジストリ値の型とデータを取得します。(ANSI)

戻り値

関数が成功すると、戻り値は ERROR_SUCCESS です。

関数が失敗すると、戻り値はシステムエラーコードになります。

pvData バッファーが値を受け取るには小さすぎる場合、関数は ERROR_MORE_DATA を返します。

lpValue レジストリ値が存在しない場合、関数は ERROR_FILE_NOT_FOUND を返します。

dwFlags に RRF_SUBKEY_WOW6464KEY と RRF_SUBKEY_WOW6432KEY の両方の組み合わせが指定されている場合、関数は ERROR_INVALID_PARAMETER を返します。

解説(Remarks)

アプリケーションは通常、RegEnumValue を呼び出して値の名前を特定し、続いて RegGetValue を呼び出してその名前のデータを取得します。

データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型で、この関数の ANSI 版が使用される場合(RegGetValueA を明示的に呼び出すか、Windows.h ファイルをインクルードする前に UNICODE を定義しないことによる)、この関数は格納されている Unicode 文字列を ANSI 文字列に変換してから pvData が指すバッファーにコピーします。

hkey に HKEY_PERFORMANCE_DATA ハンドルを設定し、指定したオブジェクトの値文字列を指定してこの関数を呼び出すと、返されるデータ構造に要求していないオブジェクトが含まれることがあります。これは正常な動作なので問題ありません。返されたデータ構造を走査して、要求したオブジェクトを探すことを常に想定しておく必要があります。

特定のレジストリキーにアクセスする操作はリダイレクトされる点に注意してください。詳細については、レジストリの仮想化およびレジストリ内の 32 ビットおよび 64 ビットアプリケーションデータを参照してください。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。詳細については、 Windows ヘッダーの使用を参照してください。

メモ

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

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

各言語での呼び出し定義

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

WIN32_ERROR RegGetValueA(
    HKEY hkey,
    LPCSTR lpSubKey,   // optional
    LPCSTR lpValue,   // optional
    REG_ROUTINE_FLAGS dwFlags,
    REG_VALUE_TYPE* pdwType,   // optional
    void* pvData,   // optional
    DWORD* pcbData   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegGetValueA(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpValue,   // LPCSTR optional
    uint dwFlags,   // REG_ROUTINE_FLAGS
    IntPtr pdwType,   // REG_VALUE_TYPE* optional, out
    IntPtr pvData,   // void* optional, out
    IntPtr pcbData   // DWORD* optional, in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegGetValueA(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpValue As String,   ' LPCSTR optional
    dwFlags As UInteger,   ' REG_ROUTINE_FLAGS
    pdwType As IntPtr,   ' REG_VALUE_TYPE* optional, out
    pvData As IntPtr,   ' void* optional, out
    pcbData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hkey : HKEY
' lpSubKey : LPCSTR optional
' lpValue : LPCSTR optional
' dwFlags : REG_ROUTINE_FLAGS
' pdwType : REG_VALUE_TYPE* optional, out
' pvData : void* optional, out
' pcbData : DWORD* optional, in/out
Declare PtrSafe Function RegGetValueA Lib "advapi32" ( _
    ByVal hkey As LongPtr, _
    ByVal lpSubKey As String, _
    ByVal lpValue As String, _
    ByVal dwFlags 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

RegGetValueA = ctypes.windll.advapi32.RegGetValueA
RegGetValueA.restype = wintypes.DWORD
RegGetValueA.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCSTR,  # lpSubKey : LPCSTR optional
    wintypes.LPCSTR,  # lpValue : LPCSTR optional
    wintypes.DWORD,  # dwFlags : REG_ROUTINE_FLAGS
    ctypes.c_void_p,  # pdwType : REG_VALUE_TYPE* 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('ADVAPI32.dll')
RegGetValueA = Fiddle::Function.new(
  lib['RegGetValueA'],
  [
    Fiddle::TYPE_VOIDP,  # hkey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpValue : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : REG_ROUTINE_FLAGS
    Fiddle::TYPE_VOIDP,  # pdwType : REG_VALUE_TYPE* optional, out
    Fiddle::TYPE_VOIDP,  # pvData : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbData : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegGetValueA(
        hkey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u8,  // LPCSTR optional
        lpValue: *const u8,  // LPCSTR optional
        dwFlags: u32,  // REG_ROUTINE_FLAGS
        pdwType: *mut u32,  // REG_VALUE_TYPE* 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("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegGetValueA(IntPtr hkey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, [MarshalAs(UnmanagedType.LPStr)] string lpValue, uint dwFlags, IntPtr pdwType, IntPtr pvData, IntPtr pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegGetValueA' -Namespace Win32 -PassThru
# $api::RegGetValueA(hkey, lpSubKey, lpValue, dwFlags, pdwType, pvData, pcbData)

#uselib "ADVAPI32.dll"
#func global RegGetValueA "RegGetValueA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RegGetValueA hkey, lpSubKey, lpValue, dwFlags, varptr(pdwType), pvData, varptr(pcbData)   ; 戻り値は stat
; hkey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "sptr"
; lpValue : LPCSTR optional -> "sptr"
; dwFlags : REG_ROUTINE_FLAGS -> "sptr"
; pdwType : REG_VALUE_TYPE* optional, out -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegGetValueA "RegGetValueA" sptr, str, str, int, var, sptr, var
; res = RegGetValueA(hkey, lpSubKey, lpValue, dwFlags, pdwType, pvData, pcbData)
; hkey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "str"
; lpValue : LPCSTR optional -> "str"
; dwFlags : REG_ROUTINE_FLAGS -> "int"
; pdwType : REG_VALUE_TYPE* optional, out -> "var"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegGetValueA "RegGetValueA" sptr, str, str, int, sptr, sptr, sptr
; res = RegGetValueA(hkey, lpSubKey, lpValue, dwFlags, varptr(pdwType), pvData, varptr(pcbData))
; hkey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "str"
; lpValue : LPCSTR optional -> "str"
; dwFlags : REG_ROUTINE_FLAGS -> "int"
; pdwType : REG_VALUE_TYPE* optional, out -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。