RegQueryValueW

関数

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

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

シグネチャ

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

WIN32_ERROR RegQueryValueW(
    HKEY hKey,
    LPCWSTR lpSubKey,   // optional
    LPWSTR lpData,   // optional
    INT* lpcbData   // optional
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	開いているレジストリキーへのハンドル。キーは KEY_QUERY_VALUE アクセス権で開かれている必要があります。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。このハンドルは、 RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。また、次のいずれかの定義済みキーを指定することもできます: HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS
lpSubKey	LPCWSTR	inoptional	既定値を取得する対象となる、hKey パラメーターのサブキーの名前。キー名は大文字と小文字を区別しません。このパラメーターが NULL または空の文字列を指す場合、関数は hKey で識別されるキーの既定値を取得します。詳細については、レジストリ要素のサイズ制限を参照してください。
lpData	LPWSTR	outoptional	指定したキーの既定値を受け取るバッファーへのポインター。 lpValue が NULL で、lpcbValue が NULL 以外の場合、関数は ERROR_SUCCESS を返し、データのサイズ(バイト単位)を lpcbValue が指す変数に格納します。これにより、アプリケーションは値のデータ用バッファーを割り当てる最適な方法を判断できます。
lpcbData	INT*	inoutoptional	lpValue パラメーターが指すバッファーのサイズ(バイト単位)を指定する変数へのポインター。関数が戻るとき、この変数には終端の null 文字を含めて lpValue にコピーされたデータのサイズが格納されます。データが REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型の場合、このサイズには終端の null 文字が含まれます。詳細については「解説」を参照してください。 lpValue で指定したバッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを lpcbValue が指す変数に格納します。この場合、lpValue バッファーの内容は未定義です。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 終端文字が必要であることに注意してください。)

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

メモ

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

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

各言語での呼び出し定義

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

WIN32_ERROR RegQueryValueW(
    HKEY hKey,
    LPCWSTR lpSubKey,   // optional
    LPWSTR lpData,   // optional
    INT* lpcbData   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RegQueryValueW(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string lpSubKey,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpData,   // LPWSTR optional, out
    IntPtr lpcbData   // INT* optional, in/out
);

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

' hKey : HKEY
' lpSubKey : LPCWSTR optional
' lpData : LPWSTR optional, out
' lpcbData : INT* optional, in/out
Declare PtrSafe Function RegQueryValueW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As LongPtr, _
    ByVal lpData As LongPtr, _
    ByVal lpcbData 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegQueryValueW = Fiddle::Function.new(
  lib['RegQueryValueW'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpData : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcbData : INT* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn RegQueryValueW(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u16,  // LPCWSTR optional
        lpData: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint RegQueryValueW(IntPtr hKey, [MarshalAs(UnmanagedType.LPWStr)] string lpSubKey, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpData, IntPtr lpcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegQueryValueW' -Namespace Win32 -PassThru
# $api::RegQueryValueW(hKey, lpSubKey, lpData, lpcbData)

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

出力引数:

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