ホーム › System.Registry › RegLoadMUIStringW

RegLoadMUIStringW

関数

レジストリ値からローカライズされた文字列を読み込む。

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

シグネチャ

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

WIN32_ERROR RegLoadMUIStringW(
    HKEY hKey,
    LPCWSTR pszValue,   // optional
    LPWSTR pszOutBuf,   // optional
    DWORD cbOutBuf,
    DWORD* pcbData,   // optional
    DWORD Flags,
    LPCWSTR pszDirectory   // optional
);

パラメーター

名前

型

方向

説明

hKey

HKEY

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

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

pszValue

LPCWSTR

inoptional

レジストリ値の名前。

pszOutBuf

LPWSTR

outoptional

文字列を受け取るバッファーへのポインター。

次の形式の文字列は特別に処理されます:

@[path]\dllname,-strID

識別子 strID を持つ文字列が dllname から読み込まれます。path は省略可能です。pszDirectory パラメーターが NULL でない場合、そのディレクトリがレジストリデータで指定されたパスの先頭に付加されます。なお、dllname には展開対象の環境変数を含めることができます。

cbOutBuf

DWORD

pszOutBuf バッファーのサイズ(バイト単位)。

pcbData

DWORD*

outoptional

pszOutBuf バッファーにコピーされたデータのサイズ(バイト単位)を受け取る変数へのポインター。

バッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを pcbData が指す変数に格納します。この場合、バッファーの内容は未定義です。

Flags

DWORD

このパラメーターには 0 または次の値を指定できます。

Value	Meaning
REG_MUI_STRING_TRUNCATE 0x00000001	文字列は pszOutBuf バッファーの利用可能なサイズに収まるように切り詰められます。このフラグを指定する場合、pcbData は NULL でなければなりません。

pszDirectory

LPCWSTR

inoptional

ディレクトリパス。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したキーおよびサブキーから、指定した文字列を読み込みます。(Unicode)

戻り値

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

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

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

この関数の ANSI バージョンは ERROR_CALL_NOT_IMPLEMENTED を返します。

解説(Remarks)

RegLoadMUIString 関数は Unicode でのみサポートされています。この関数には Unicode (W) 版と ANSI (A) 版の両方が宣言されていますが、RegLoadMUIStringA 関数は ERROR_CALL_NOT_IMPLEMENTED を返します。アプリケーションは RegLoadMUIStringW を明示的に呼び出すか、プラットフォーム呼び出し (PInvoke) で文字セットとして Unicode を指定する必要があります。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegLoadMUIStringW(
    HKEY hKey,
    LPCWSTR pszValue,   // optional
    LPWSTR pszOutBuf,   // optional
    DWORD cbOutBuf,
    DWORD* pcbData,   // optional
    DWORD Flags,
    LPCWSTR pszDirectory   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RegLoadMUIStringW(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string pszValue,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOutBuf,   // LPWSTR optional, out
    uint cbOutBuf,   // DWORD
    IntPtr pcbData,   // DWORD* optional, out
    uint Flags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pszDirectory   // LPCWSTR optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RegLoadMUIStringW(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> pszValue As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszOutBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    cbOutBuf As UInteger,   ' DWORD
    pcbData As IntPtr,   ' DWORD* optional, out
    Flags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszDirectory As String   ' LPCWSTR optional
) As UInteger
End Function

' hKey : HKEY
' pszValue : LPCWSTR optional
' pszOutBuf : LPWSTR optional, out
' cbOutBuf : DWORD
' pcbData : DWORD* optional, out
' Flags : DWORD
' pszDirectory : LPCWSTR optional
Declare PtrSafe Function RegLoadMUIStringW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal pszValue As LongPtr, _
    ByVal pszOutBuf As LongPtr, _
    ByVal cbOutBuf As Long, _
    ByVal pcbData As LongPtr, _
    ByVal Flags As Long, _
    ByVal pszDirectory 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

RegLoadMUIStringW = ctypes.windll.advapi32.RegLoadMUIStringW
RegLoadMUIStringW.restype = wintypes.DWORD
RegLoadMUIStringW.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCWSTR,  # pszValue : LPCWSTR optional
    wintypes.LPWSTR,  # pszOutBuf : LPWSTR optional, out
    wintypes.DWORD,  # cbOutBuf : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbData : DWORD* optional, out
    wintypes.DWORD,  # Flags : DWORD
    wintypes.LPCWSTR,  # pszDirectory : LPCWSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegLoadMUIStringW = Fiddle::Function.new(
  lib['RegLoadMUIStringW'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # pszValue : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pszOutBuf : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cbOutBuf : DWORD
    Fiddle::TYPE_VOIDP,  # pcbData : DWORD* optional, out
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # pszDirectory : LPCWSTR optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn RegLoadMUIStringW(
        hKey: *mut core::ffi::c_void,  // HKEY
        pszValue: *const u16,  // LPCWSTR optional
        pszOutBuf: *mut u16,  // LPWSTR optional, out
        cbOutBuf: u32,  // DWORD
        pcbData: *mut u32,  // DWORD* optional, out
        Flags: u32,  // DWORD
        pszDirectory: *const u16  // LPCWSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint RegLoadMUIStringW(IntPtr hKey, [MarshalAs(UnmanagedType.LPWStr)] string pszValue, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOutBuf, uint cbOutBuf, IntPtr pcbData, uint Flags, [MarshalAs(UnmanagedType.LPWStr)] string pszDirectory);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegLoadMUIStringW' -Namespace Win32 -PassThru
# $api::RegLoadMUIStringW(hKey, pszValue, pszOutBuf, cbOutBuf, pcbData, Flags, pszDirectory)

#uselib "ADVAPI32.dll"
#func global RegLoadMUIStringW "RegLoadMUIStringW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; RegLoadMUIStringW hKey, pszValue, varptr(pszOutBuf), cbOutBuf, varptr(pcbData), Flags, pszDirectory   ; 戻り値は stat
; hKey : HKEY -> "wptr"
; pszValue : LPCWSTR optional -> "wptr"
; pszOutBuf : LPWSTR optional, out -> "wptr"
; cbOutBuf : DWORD -> "wptr"
; pcbData : DWORD* optional, out -> "wptr"
; Flags : DWORD -> "wptr"
; pszDirectory : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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