ホーム › UI.WindowsAndMessaging › LoadStringW

LoadStringW

関数

リソースから文字列をUnicodeで読み込む。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT LoadStringW(
    HINSTANCE hInstance,   // optional
    DWORD uID,
    LPWSTR lpBuffer,
    INT cchBufferMax
);

パラメーター

名前	型	方向	説明
hInstance	HINSTANCE	inoptional	文字列リソースを含む実行可能ファイルを持つモジュールのインスタンスへのハンドル。アプリケーション自身のハンドルを取得するには、GetModuleHandle 関数を NULL を指定して呼び出します。
uID	DWORD	in	読み込む文字列の識別子。
lpBuffer	LPWSTR	out	文字列を受け取るバッファ(cchBufferMax が 0 以外の場合)、または文字列リソース自体への読み取り専用ポインター(cchBufferMax が 0 の場合)。ポインター(8 バイト)を保持できる十分な長さが必要です。
cchBufferMax	INT	in	バッファのサイズ(文字数単位)。文字列が指定した文字数より長い場合、文字列は切り詰められ null で終端されます。このパラメーターが 0 の場合、lpBuffer は文字列リソース自体への読み取り専用ポインターを受け取ります。

戻り値の型: INT

公式ドキュメント

指定したモジュールに関連付けられた実行可能ファイルから文字列リソースを読み込み、その文字列をバッファにコピーして、終端の null 文字を付加します。(Unicode)

戻り値

型: int

関数が成功した場合、戻り値は次のいずれかになります。

バッファにコピーされた文字数(cchBufferMax が 0 以外の場合)。終端の null 文字は含みません。
lpBuffer が指す文字列リソース内の文字数(cchBufferMax が 0 の場合)。文字列リソースはモジュールのリソーステーブル内で null 終端されているとは限らないため、この値を使用して文字列リソースの終端位置を判断できます。
文字列リソースが存在しない場合は 0。

拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

cchBufferMax に 0 を渡して lpBuffer パラメーターに文字列リソースへの読み取り専用ポインターを返す場合、戻り値の文字数を使用して文字列リソースの長さを判断します。文字列リソースはモジュールのリソーステーブル内で null 終端されているとは限りません。ただし、リソーステーブルには null 文字が含まれることがあります。文字列リソースは 16 個の文字列を単位とするブロックに格納され、ブロック内の空きスロットは null 文字で示されます。

セキュリティに関する注意

この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。誤った使用には、nBufferMax パラメーターに間違ったサイズを指定することが含まれます。たとえば、lpBuffer が TCHAR szBuffer[100] として宣言されたバッファ szBuffer を指している場合、sizeof(szBuffer) はバッファのサイズをバイト単位で返すため、この関数の Unicode 版ではバッファオーバーフローを引き起こす可能性があります。バッファオーバーフローは、アプリケーションにおける多くのセキュリティ問題の原因です。この場合、sizeof(szBuffer)/sizeof(TCHAR) または sizeof(szBuffer)/sizeof(szBuffer[0]) を使用すれば、バッファの正しいサイズが得られます。

例

例については、子ウィンドウの作成を参照してください。

メモ

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

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

各言語での呼び出し定義

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

INT LoadStringW(
    HINSTANCE hInstance,   // optional
    DWORD uID,
    LPWSTR lpBuffer,
    INT cchBufferMax
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int LoadStringW(
    IntPtr hInstance,   // HINSTANCE optional
    uint uID,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR out
    int cchBufferMax   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadStringW(
    hInstance As IntPtr,   ' HINSTANCE optional
    uID As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR out
    cchBufferMax As Integer   ' INT
) As Integer
End Function

' hInstance : HINSTANCE optional
' uID : DWORD
' lpBuffer : LPWSTR out
' cchBufferMax : INT
Declare PtrSafe Function LoadStringW Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal uID As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal cchBufferMax As Long) 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

LoadStringW = ctypes.windll.user32.LoadStringW
LoadStringW.restype = ctypes.c_int
LoadStringW.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.DWORD,  # uID : DWORD
    wintypes.LPWSTR,  # lpBuffer : LPWSTR out
    ctypes.c_int,  # cchBufferMax : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadStringW = Fiddle::Function.new(
  lib['LoadStringW'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    -Fiddle::TYPE_INT,  # uID : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR out
    Fiddle::TYPE_INT,  # cchBufferMax : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn LoadStringW(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        uID: u32,  // DWORD
        lpBuffer: *mut u16,  // LPWSTR out
        cchBufferMax: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int LoadStringW(IntPtr hInstance, uint uID, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, int cchBufferMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadStringW' -Namespace Win32 -PassThru
# $api::LoadStringW(hInstance, uID, lpBuffer, cchBufferMax)

#uselib "USER32.dll"
#func global LoadStringW "LoadStringW" wptr, wptr, wptr, wptr
; LoadStringW hInstance, uID, varptr(lpBuffer), cchBufferMax   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "wptr"
; uID : DWORD -> "wptr"
; lpBuffer : LPWSTR out -> "wptr"
; cchBufferMax : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global LoadStringW "LoadStringW" sptr, int, var, int
; res = LoadStringW(hInstance, uID, lpBuffer, cchBufferMax)
; hInstance : HINSTANCE optional -> "sptr"
; uID : DWORD -> "int"
; lpBuffer : LPWSTR out -> "var"
; cchBufferMax : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global LoadStringW "LoadStringW" sptr, int, sptr, int
; res = LoadStringW(hInstance, uID, varptr(lpBuffer), cchBufferMax)
; hInstance : HINSTANCE optional -> "sptr"
; uID : DWORD -> "int"
; lpBuffer : LPWSTR out -> "sptr"
; cchBufferMax : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。