RegQueryValueA

関数

指定キーの既定値を取得する旧式の関数。

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

シグネチャ

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

WIN32_ERROR RegQueryValueA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    LPSTR lpData,   // optional
    INT* 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_USERS
lpSubKey	LPCSTR	inoptional	既定値を取得する対象となる、hKey パラメーターのサブキーの名前。キー名では大文字と小文字は区別されません。このパラメーターが NULL または空文字列を指す場合、関数は hKey で識別されるキーの既定値を取得します。詳細については、 Registry Element Size Limits を参照してください。
lpData	LPSTR	outoptional	指定したキーの既定値を受け取るバッファーへのポインター。 lpValue が NULL で、かつ lpcbValue が NULL 以外の場合、関数は ERROR_SUCCESS を返し、データのサイズ(バイト単位)を lpcbValue が指す変数に格納します。これにより、アプリケーションは値のデータ用にバッファーを割り当てる最適な方法を判断できます。
lpcbData	INT*	inoutoptional	lpValue パラメーターが指すバッファーのサイズをバイト単位で指定する変数へのポインター。関数が戻るとき、この変数には lpValue にコピーされたデータのサイズが、終端の null 文字を含めて格納されます。データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、このサイズには終端の null 文字が含まれます。詳細については「解説」を参照してください。 lpValue で指定したバッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを lpcbValue が指す変数に格納します。この場合、lpValue バッファーの内容は未定義です。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリキーの既定値(名前のない値)に関連付けられたデータを取得します。データは null で終わる文字列である必要があります。(ANSI)

戻り値

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

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

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

解説(Remarks)

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

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

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

メモ

winreg.h ヘッダーは RegQueryValue を、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 RegQueryValueA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    LPSTR lpData,   // optional
    INT* lpcbData   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegQueryValueA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpData,   // LPSTR optional, out
    IntPtr lpcbData   // INT* optional, in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegQueryValueA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpData As System.Text.StringBuilder,   ' LPSTR optional, out
    lpcbData As IntPtr   ' INT* optional, in/out
) As UInteger
End Function

' hKey : HKEY
' lpSubKey : LPCSTR optional
' lpData : LPSTR optional, out
' lpcbData : INT* optional, in/out
Declare PtrSafe Function RegQueryValueA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As String, _
    ByVal lpData As String, _
    ByVal lpcbData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegQueryValueA = ctypes.windll.advapi32.RegQueryValueA
RegQueryValueA.restype = wintypes.DWORD
RegQueryValueA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpSubKey : LPCSTR optional
    wintypes.LPSTR,  # lpData : LPSTR optional, out
    ctypes.POINTER(ctypes.c_int),  # lpcbData : INT* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegQueryValueA = Fiddle::Function.new(
  lib['RegQueryValueA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpData : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcbData : INT* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegQueryValueA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u8,  // LPCSTR optional
        lpData: *mut u8,  // LPSTR optional, out
        lpcbData: *mut i32  // INT* 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 RegQueryValueA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpData, IntPtr lpcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegQueryValueA' -Namespace Win32 -PassThru
# $api::RegQueryValueA(hKey, lpSubKey, lpData, lpcbData)

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

出力引数:

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