ホーム › System.Registry › RegQueryMultipleValuesA

RegQueryMultipleValuesA

関数

指定キーから複数のレジストリ値を一括取得する。

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

シグネチャ

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

WIN32_ERROR RegQueryMultipleValuesA(
    HKEY hKey,
    VALENTA* val_list,
    DWORD num_vals,
    LPSTR lpValueBuf,   // optional
    DWORD* ldwTotsize   // 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_USERS
val_list	VALENTA*	out	1 つ以上の値エントリを記述する VALENT 構造体の配列へのポインター。入力時には、各構造体の ve_valuename メンバーに、取得する値の名前へのポインターを格納しておく必要があります。指定した値のいずれかが指定したキー内に存在しない場合、この関数は失敗します。関数が成功した場合、配列の各要素には指定した値の情報が格納されます。
num_vals	DWORD	in	val_list 配列内の要素数。
lpValueBuf	LPSTR	outoptional	バッファーへのポインター。関数が成功した場合、バッファーには各値のデータが格納されます。 lpValueBuf が NULL の場合、ldwTotsize パラメーターが指す値はゼロでなければなりません。この場合、関数は ERROR_MORE_DATA を返し、ldwTotsize には必要なバッファーのサイズ(バイト単位)が格納されます。
ldwTotsize	DWORD*	inoutoptional	lpValueBuf パラメーターが指すバッファーのサイズ(バイト単位)を指定する変数へのポインター。関数が成功した場合、ldwTotsize にはバッファーにコピーされたバイト数が格納されます。バッファーが小さすぎて関数が失敗した場合、ldwTotsize には必要なサイズ(バイト単位)が格納されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値	説明
ERROR_CANTREAD	RegQueryMultipleValues が動的キーのプロバイダーをインスタンス化またはアクセスできません。
ERROR_MORE_DATA	lpValueBuf が指すバッファーが小さすぎました。この場合、ldwTotsize には必要なバッファーサイズが格納されます。
ERROR_TRANSFER_TOO_LONG	要求されたデータの合計サイズ(val_list 配列のサイズ + ldwTotSize)が、システムの上限である 1 メガバイトを超えています。

解説(Remarks)

RegQueryMultipleValues 関数を使用すると、アプリケーションは静的キーまたは動的キーの 1 つ以上の値を照会できます。対象のキーが静的キーである場合、システムはすべての値をアトミックに提供します。過度なシリアル化を防ぐため、この関数が返す集約データは 1 メガバイトを超えることはできません。

対象のキーが動的キーである場合、そのプロバイダーはすべての値をアトミックに提供する必要があります。つまり、プロバイダーは結果バッファーを同期的に埋め、過度なシリアル化を避けつつ、バッファー内のすべての値について一貫したビューを提供する必要があります。プロバイダーは、この関数へのアトミックな呼び出し中に、合計で最大 1 メガバイトの出力データを提供できます。

RegQueryMultipleValues はリモートでサポートされています。つまり、関数に渡される hKey パラメーターはリモートコンピューターを参照できます。

メモ

winreg.h ヘッダーは RegQueryMultipleValues を、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 RegQueryMultipleValuesA(
    HKEY hKey,
    VALENTA* val_list,
    DWORD num_vals,
    LPSTR lpValueBuf,   // optional
    DWORD* ldwTotsize   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegQueryMultipleValuesA(
    IntPtr hKey,   // HKEY
    IntPtr val_list,   // VALENTA* out
    uint num_vals,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpValueBuf,   // LPSTR optional, out
    IntPtr ldwTotsize   // DWORD* optional, in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegQueryMultipleValuesA(
    hKey As IntPtr,   ' HKEY
    val_list As IntPtr,   ' VALENTA* out
    num_vals As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpValueBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    ldwTotsize As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hKey : HKEY
' val_list : VALENTA* out
' num_vals : DWORD
' lpValueBuf : LPSTR optional, out
' ldwTotsize : DWORD* optional, in/out
Declare PtrSafe Function RegQueryMultipleValuesA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal val_list As LongPtr, _
    ByVal num_vals As Long, _
    ByVal lpValueBuf As String, _
    ByVal ldwTotsize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegQueryMultipleValuesA = ctypes.windll.advapi32.RegQueryMultipleValuesA
RegQueryMultipleValuesA.restype = wintypes.DWORD
RegQueryMultipleValuesA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    ctypes.c_void_p,  # val_list : VALENTA* out
    wintypes.DWORD,  # num_vals : DWORD
    wintypes.LPSTR,  # lpValueBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # ldwTotsize : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegQueryMultipleValuesA = Fiddle::Function.new(
  lib['RegQueryMultipleValuesA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # val_list : VALENTA* out
    -Fiddle::TYPE_INT,  # num_vals : DWORD
    Fiddle::TYPE_VOIDP,  # lpValueBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # ldwTotsize : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegQueryMultipleValuesA(
        hKey: *mut core::ffi::c_void,  // HKEY
        val_list: *mut VALENTA,  // VALENTA* out
        num_vals: u32,  // DWORD
        lpValueBuf: *mut u8,  // LPSTR optional, out
        ldwTotsize: *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 RegQueryMultipleValuesA(IntPtr hKey, IntPtr val_list, uint num_vals, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpValueBuf, IntPtr ldwTotsize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegQueryMultipleValuesA' -Namespace Win32 -PassThru
# $api::RegQueryMultipleValuesA(hKey, val_list, num_vals, lpValueBuf, ldwTotsize)

#uselib "ADVAPI32.dll"
#func global RegQueryMultipleValuesA "RegQueryMultipleValuesA" sptr, sptr, sptr, sptr, sptr
; RegQueryMultipleValuesA hKey, varptr(val_list), num_vals, varptr(lpValueBuf), varptr(ldwTotsize)   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; val_list : VALENTA* out -> "sptr"
; num_vals : DWORD -> "sptr"
; lpValueBuf : LPSTR optional, out -> "sptr"
; ldwTotsize : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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