ホーム › System.Registry › RegQueryValueExA

RegQueryValueExA

関数

指定した名前のレジストリ値とその型を取得する。

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

シグネチャ

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

WIN32_ERROR RegQueryValueExA(
    HKEY hKey,
    LPCSTR lpValueName,   // optional
    DWORD* lpReserved,   // optional
    REG_VALUE_TYPE* lpType,   // optional
    BYTE* lpData,   // optional
    DWORD* lpcbData   // optional
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	開いているレジストリキーへのハンドル。このキーは KEY_QUERY_VALUE アクセス権で開かれている必要があります。詳細については、 Registry Key Security and Access Rights を参照してください。このハンドルは、 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
lpValueName	LPCSTR	inoptional	レジストリ値の名前。 lpValueName が NULL または空文字列 "" の場合、この関数はキーの名前のない値(既定値)が存在すればその型とデータを取得します。 lpValueName がレジストリに存在しない値を指定している場合、この関数は ERROR_FILE_NOT_FOUND を返します。キーは自動的に名前のない値(既定値)を持つわけではありません。名前のない値は任意の型にできます。詳細については、 Registry Element Size Limits を参照してください。
lpReserved	DWORD*	optional	このパラメーターは予約されており、NULL でなければなりません。
lpType	REG_VALUE_TYPE*	outoptional	指定された値に格納されているデータの型を示すコードを受け取る変数へのポインター。指定可能な型コードの一覧については、 Registry Value Types を参照してください。型コードが不要な場合、lpType パラメーターは NULL にできます。
lpData	BYTE*	outoptional	値のデータを受け取るバッファーへのポインター。データが不要な場合、このパラメーターは NULL にできます。
lpcbData	DWORD*	inoutoptional	lpData パラメーターが指すバッファーのサイズをバイト単位で指定する変数へのポインター。関数が返るとき、この変数には lpData にコピーされたデータのサイズが格納されます。 lpcbData パラメーターを NULL にできるのは、lpData が NULL の場合のみです。データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、このサイズには終端の null 文字が含まれます(データがそれらを伴わずに格納されていた場合を除く)。詳細については「解説」を参照してください。 lpData パラメーターで指定したバッファーがデータを保持するのに十分な大きさでない場合、この関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを lpcbData が指す変数に格納します。この場合、lpData バッファーの内容は未定義です。 lpData が NULL で lpcbData が非 NULL の場合、この関数は ERROR_SUCCESS を返し、データのサイズをバイト単位で lpcbData が指す変数に格納します。これにより、アプリケーションは値のデータ用バッファーを割り当てる最適な方法を判断できます。 hKey が HKEY_PERFORMANCE_DATA を指定しており、lpData バッファーが返されるすべてのデータを格納するのに十分な大きさでない場合、 RegQueryValueEx は ERROR_MORE_DATA を返し、lpcbData パラメーターを通じて返される値は未定義です。これは、パフォーマンスデータのサイズが呼び出しごとに変化する可能性があるためです。この場合、バッファーサイズを増やし、更新したバッファーサイズを lpcbData パラメーターに渡して RegQueryValueEx を再度呼び出す必要があります。関数が成功するまでこれを繰り返してください。lpcbData によって返される値は予測できないため、バッファーサイズを追跡するための別個の変数を保持する必要があります。 lpValueName のレジストリ値が存在しない場合、RegQueryValueEx は ERROR_FILE_NOT_FOUND を返し、lpcbData パラメーターを通じて返される値は未定義です。

戻り値の型: WIN32_ERROR

公式ドキュメント

開いているレジストリキーに関連付けられた、指定された値名の型とデータを取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステムエラーコードです。

lpData バッファーがデータを受け取るには小さすぎる場合、この関数は ERROR_MORE_DATA を返します。

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

解説(Remarks)

アプリケーションは通常、RegEnumValue を呼び出して値名を取得し、次に RegQueryValueEx を呼び出してそれらの名前のデータを取得します。

データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、文字列が適切な終端の null 文字とともに格納されていないことがあります。そのため、関数が ERROR_SUCCESS を返した場合でも、アプリケーションは文字列を使用する前に適切に終端されていることを確認する必要があります。そうしないと、バッファーを上書きする可能性があります。(REG_MULTI_SZ 文字列には終端の null 文字が 2 つ必要であることに注意してください。)アプリケーションが文字列を適切に終端させる方法の 1 つは、必要に応じて終端の null 文字を追加する RegGetValue を使用することです。

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

hKey を HKEY_PERFORMANCE_DATA ハンドルに設定し、指定したオブジェクトの値文字列を指定して RegQueryValueEx 関数を呼び出すと、返されるデータ構造に要求していないオブジェクトが含まれることがあります。これは正常な動作なので、驚かないでください。 RegQueryValueEx 関数を呼び出す際は、返されたデータ構造をたどって要求したオブジェクトを探すことを常に想定してください。

特定のレジストリキーにアクセスする操作はリダイレクトされることに注意してください。詳細については、Registry Virtualization および 32-bit and 64-bit Application Data in the Registry を参照してください。

例

この関数を呼び出すたびに、lpcbData パラメーターが指す値を必ず再初期化してください。これは、次のコード例のようにループ内でこの関数を呼び出す場合に非常に重要です。

#include <windows.h>
#include <malloc.h>
#include <stdio.h>

#define TOTALBYTES    8192
#define BYTEINCREMENT 4096

void main()
{
    DWORD BufferSize = TOTALBYTES;
    DWORD cbData;
    DWORD dwRet;

    PPERF_DATA_BLOCK PerfData = (PPERF_DATA_BLOCK) malloc( BufferSize );
    cbData = BufferSize;

    printf("\nRetrieving the data...");

    dwRet = RegQueryValueEx( HKEY_PERFORMANCE_DATA,
                             TEXT("Global"),
                             NULL,
                             NULL,
                             (LPBYTE) PerfData,
                             &cbData );
    while( dwRet == ERROR_MORE_DATA )
    {
        // Get a buffer that is big enough.

        BufferSize += BYTEINCREMENT;
        PerfData = (PPERF_DATA_BLOCK) realloc( PerfData, BufferSize );
        cbData = BufferSize;

        printf(".");
        dwRet = RegQueryValueEx( HKEY_PERFORMANCE_DATA,
                         TEXT("Global"),
                         NULL,
                         NULL,
                         (LPBYTE) PerfData,
                         &cbData );
    }
    if( dwRet == ERROR_SUCCESS )
        printf("\n\nFinal buffer size is %d\n", BufferSize);
    else printf("\nRegQueryValueEx failed (%d)\n", dwRet);
}

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegQueryValueExA(
    HKEY hKey,
    LPCSTR lpValueName,   // optional
    DWORD* lpReserved,   // optional
    REG_VALUE_TYPE* lpType,   // optional
    BYTE* lpData,   // optional
    DWORD* lpcbData   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegQueryValueExA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpValueName,   // LPCSTR optional
    IntPtr lpReserved,   // DWORD* optional
    IntPtr lpType,   // REG_VALUE_TYPE* optional, out
    IntPtr lpData,   // BYTE* optional, out
    IntPtr lpcbData   // DWORD* optional, in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegQueryValueExA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpValueName As String,   ' LPCSTR optional
    lpReserved As IntPtr,   ' DWORD* optional
    lpType As IntPtr,   ' REG_VALUE_TYPE* optional, out
    lpData As IntPtr,   ' BYTE* optional, out
    lpcbData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hKey : HKEY
' lpValueName : LPCSTR optional
' lpReserved : DWORD* optional
' lpType : REG_VALUE_TYPE* optional, out
' lpData : BYTE* optional, out
' lpcbData : DWORD* optional, in/out
Declare PtrSafe Function RegQueryValueExA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpValueName As String, _
    ByVal lpReserved As LongPtr, _
    ByVal lpType As LongPtr, _
    ByVal lpData As LongPtr, _
    ByVal lpcbData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegQueryValueExA = ctypes.windll.advapi32.RegQueryValueExA
RegQueryValueExA.restype = wintypes.DWORD
RegQueryValueExA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpValueName : LPCSTR optional
    ctypes.POINTER(wintypes.DWORD),  # lpReserved : DWORD* optional
    ctypes.c_void_p,  # lpType : REG_VALUE_TYPE* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # lpData : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbData : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegQueryValueExA = Fiddle::Function.new(
  lib['RegQueryValueExA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpValueName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpReserved : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpType : REG_VALUE_TYPE* optional, out
    Fiddle::TYPE_VOIDP,  # lpData : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbData : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegQueryValueExA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpValueName: *const u8,  // LPCSTR optional
        lpReserved: *mut u32,  // DWORD* optional
        lpType: *mut u32,  // REG_VALUE_TYPE* optional, out
        lpData: *mut u8,  // BYTE* optional, out
        lpcbData: *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 RegQueryValueExA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpValueName, IntPtr lpReserved, IntPtr lpType, IntPtr lpData, IntPtr lpcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegQueryValueExA' -Namespace Win32 -PassThru
# $api::RegQueryValueExA(hKey, lpValueName, lpReserved, lpType, lpData, lpcbData)

#uselib "ADVAPI32.dll"
#func global RegQueryValueExA "RegQueryValueExA" sptr, sptr, sptr, sptr, sptr, sptr
; RegQueryValueExA hKey, lpValueName, varptr(lpReserved), varptr(lpType), varptr(lpData), varptr(lpcbData)   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpValueName : LPCSTR optional -> "sptr"
; lpReserved : DWORD* optional -> "sptr"
; lpType : REG_VALUE_TYPE* optional, out -> "sptr"
; lpData : BYTE* optional, out -> "sptr"
; lpcbData : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegQueryValueExA "RegQueryValueExA" sptr, str, var, var, var, var
; res = RegQueryValueExA(hKey, lpValueName, lpReserved, lpType, lpData, lpcbData)
; hKey : HKEY -> "sptr"
; lpValueName : LPCSTR optional -> "str"
; lpReserved : DWORD* optional -> "var"
; lpType : REG_VALUE_TYPE* optional, out -> "var"
; lpData : BYTE* optional, out -> "var"
; lpcbData : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegQueryValueExA "RegQueryValueExA" sptr, str, sptr, sptr, sptr, sptr
; res = RegQueryValueExA(hKey, lpValueName, varptr(lpReserved), varptr(lpType), varptr(lpData), varptr(lpcbData))
; hKey : HKEY -> "sptr"
; lpValueName : LPCSTR optional -> "str"
; lpReserved : DWORD* optional -> "sptr"
; lpType : REG_VALUE_TYPE* optional, out -> "sptr"
; lpData : BYTE* optional, out -> "sptr"
; lpcbData : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。