FormatMessageW
関数シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
DWORD FormatMessageW(
FORMAT_MESSAGE_OPTIONS dwFlags,
const void* lpSource, // optional
DWORD dwMessageId,
DWORD dwLanguageId,
LPWSTR lpBuffer,
DWORD nSize,
CHAR** Arguments // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| dwFlags | FORMAT_MESSAGE_OPTIONS | in | 書式設定オプション、および lpSource パラメーターの解釈方法を指定します。dwFlags の下位バイトは、出力バッファー内の改行の処理方法を指定します。下位バイトは、書式設定された出力行の最大幅も指定できます。 このパラメーターには、次の値のうち 1 つ以上を指定できます。
dwFlags の下位バイトは、書式設定された出力行の最大幅を指定できます。下位バイトには次の値を指定できます。
下位バイトが FORMAT_MESSAGE_MAX_WIDTH_MASK 以外の 0 でない値の場合、その値は出力行内の最大文字数を指定します。関数は、メッセージ定義テキスト内の通常の改行を無視します。関数は、空白で区切られた文字列を改行で分割することはありません。関数は、メッセージ定義テキスト内のハードコードされた改行を出力バッファーに格納します。ハードコードされた改行は %n エスケープシーケンスでコーディングされます。 | ||||||||||||||||||||
| lpSource | void* | inoptional | メッセージ定義の場所。このパラメーターの型は、dwFlags パラメーターの設定によって異なります。
これらのフラグのいずれも dwFlags に設定されていない場合、lpSource は無視されます。 | ||||||||||||||||||||
| dwMessageId | DWORD | in | 要求されたメッセージのメッセージ識別子。dwFlags に FORMAT_MESSAGE_FROM_STRING が含まれている場合、このパラメーターは無視されます。 | ||||||||||||||||||||
| dwLanguageId | DWORD | in | 要求されたメッセージの言語識別子。dwFlags に FORMAT_MESSAGE_FROM_STRING が含まれている場合、このパラメーターは無視されます。 このパラメーターに特定の LANGID を渡すと、FormatMessage はその LANGID のメッセージのみを返します。その LANGID のメッセージが見つからない場合、Last-Error を ERROR_RESOURCE_LANG_NOT_FOUND に設定します。ゼロを渡すと、FormatMessage は次の順序で LANGID のメッセージを検索します。
| ||||||||||||||||||||
| lpBuffer | LPWSTR | out | 書式設定されたメッセージを指定する null 終端文字列を受け取るバッファーへのポインター。dwFlags に FORMAT_MESSAGE_ALLOCATE_BUFFER が含まれている場合、関数は LocalAlloc 関数を使用してバッファーを割り当て、そのバッファーへのポインターを lpBuffer で指定されたアドレスに格納します。 このバッファーは 64K バイトを超えることはできません。 | ||||||||||||||||||||
| nSize | DWORD | in | FORMAT_MESSAGE_ALLOCATE_BUFFER フラグが設定されていない場合、このパラメーターは出力バッファーのサイズを TCHAR 単位で指定します。FORMAT_MESSAGE_ALLOCATE_BUFFER が設定されている場合、このパラメーターは出力バッファーに割り当てる TCHAR の最小数を指定します。 出力バッファーは 64K バイトを超えることはできません。 | ||||||||||||||||||||
| Arguments | CHAR** | inoptional | 書式設定されたメッセージの挿入値として使用される値の配列。書式文字列内の %1 は Arguments 配列の最初の値を示し、%2 は 2 番目の引数を示します。以降も同様です。 各値の解釈は、メッセージ定義内の挿入に関連付けられた書式設定情報によって異なります。既定では、各値は null 終端文字列へのポインターとして扱われます。 既定では、Arguments パラメーターは va_list* 型です。これは、可変個数の引数を記述するための、言語および実装に固有のデータ型です。va_list 引数の状態は、関数から戻った時点では未定義です。va_list を再度使用するには、va_end を使用して可変引数リストポインターを破棄し、va_start で再初期化してください。 va_list* 型のポインターがない場合は、FORMAT_MESSAGE_ARGUMENT_ARRAY フラグを指定し、DWORD_PTR 値の配列へのポインターを渡します。これらの値は、挿入値として書式設定されるメッセージへの入力となります。各挿入には、配列内に対応する要素が必要です。 |
戻り値の型: DWORD
公式ドキュメント
FormatMessageW (Unicode) 関数 (winbase.h) は、メッセージ文字列を書式設定します。
戻り値
関数が成功した場合、戻り値は出力バッファーに格納された TCHAR の数 (終端の null 文字を除く) です。
関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
メッセージテキスト内では、メッセージを動的に書式設定するためのいくつかのエスケープシーケンスがサポートされています。これらのエスケープシーケンスとその意味を次の表に示します。すべてのエスケープシーケンスはパーセント文字 (%) で始まります。
| エスケープシーケンス | 意味 |
|---|---|
| %0 | 末尾の改行文字なしでメッセージテキスト行を終了します。このエスケープシーケンスは、長い行を組み立てる場合や、末尾の改行文字なしでメッセージ自体を終了する場合に使用できます。プロンプトメッセージに便利です。 |
| %n!書式文字列! |
挿入シーケンスを識別します。n の値は 1 から 99 の範囲で指定できます。書式文字列 (感嘆符で囲む必要があります) は省略可能で、指定しない場合は既定で !s! になります。詳細については、書式指定フィールドを参照してください。
書式文字列には、文字列の幅と精度の指定子、および整数の幅指定子を含めることができます。幅と精度を指定するにはアスタリスク () を使用します。例: %1!.*s! または %1!*u!。 幅と精度の指定子を使用しない場合、挿入番号は入力引数に直接対応します。たとえば、ソース文字列が "%1 %2 %1" で入力引数が "Bill" と "Bob" の場合、書式設定された出力文字列は "Bill Bob Bill" になります。 ただし、幅と精度の指定子を使用する場合、挿入番号は入力引数に直接対応しません。たとえば、前の例の挿入番号は "%1!*.*s! %4 %5!*s!" のように変わる可能性があります。 挿入番号は、引数配列 (FORMAT_MESSAGE_ARGUMENT_ARRAY) を使用するか va_list を使用するかによって異なります。引数配列の場合、前の書式文字列にアスタリスクが 1 つ含まれていれば次の挿入番号は n+2 になり、アスタリスクが 2 つ指定されていれば n+3 になります。va_list の場合、前の書式文字列にアスタリスクが 1 つ含まれていれば次の挿入番号は n+1 になり、アスタリスクが 2 つ指定されていれば n+2 になります。 前の例のように "Bill" を繰り返したい場合、引数に "Bill" を 2 回含める必要があります。たとえば、ソース文字列が "%1!*.*s! %4 %5!*s!" の場合、引数は (FORMAT_MESSAGE_ARGUMENT_ARRAY フラグを使用するとき) 4, 2, Bill, Bob, 6, Bill になります。その場合、書式設定された文字列は " Bi Bob Bill" になります。 ソース文字列に幅と精度の指定子が含まれている場合に挿入番号を繰り返すと、意図した結果が得られないことがあります。%5 を %1 に置き換えると、関数はアドレス 6 にある文字列を出力しようとします (アクセス違反になる可能性が高い)。 浮動小数点の書式指定子 (e、E、f、g) はサポートされていません。回避策として、StringCchPrintf 関数を使用して浮動小数点数を一時バッファーに書式設定し、そのバッファーを挿入文字列として使用します。 I64 プレフィックスを使用する挿入は、2 つの 32 ビット引数として扱われます。それらは後続の引数を使用する前に使用する必要があります。このプレフィックスを使用するよりも、StringCchPrintf を使用する方が簡単な場合があることに注意してください。 |
パーセント文字に続くその他の非数字文字は、パーセント文字なしで出力メッセージに書式設定されます。以下にいくつかの例を示します。
| 書式文字列 | 結果の出力 |
|---|---|
| %% | 単一のパーセント記号。 |
| %space | 単一のスペース。この書式文字列は、メッセージテキスト行の末尾に適切な数のスペースを確保するために使用できます。 |
| %. | 単一のピリオド。この書式文字列は、メッセージテキスト定義を終了させずに行の先頭に単一のピリオドを含めるために使用できます。 |
| %! | 単一の感嘆符。この書式文字列は、挿入の直後に感嘆符を含める際に、それが書式文字列の始まりと誤認されないようにするために使用できます。 |
| %n | 書式文字列が行末に現れる場合のハード改行。この書式文字列は、メッセージが特定の幅に収まるよう FormatMessage が通常の改行を提供している場合に便利です。 |
| %r | 末尾の改行文字なしのハードキャリッジリターン。 |
| %t | 単一のタブ。 |
セキュリティに関する注意
この関数を FORMAT_MESSAGE_IGNORE_INSERTS なしで呼び出す場合、Arguments パラメーターには、メッセージ文字列内のすべての挿入シーケンスを満たすのに十分なパラメーターが含まれ、かつそれらが正しい型である必要があります。したがって、挿入を有効にした状態で信頼できないメッセージ文字列や不明なメッセージ文字列を使用しないでください。それらには Arguments が提供する数を超える挿入シーケンスが含まれていたり、誤った型の挿入シーケンスが含まれていたりする可能性があるためです。特に、API から返された任意のシステムエラーコードを取得して、FORMAT_MESSAGE_IGNORE_INSERTS なしで FORMAT_MESSAGE_FROM_SYSTEM を使用することは安全ではありません。例
FormatMessage 関数は、GetLastError が返すシステムエラーコードのエラーメッセージ文字列を取得するために使用できます。例については、Last-Error コードの取得を参照してください。
次の例は、引数配列と幅および精度の指定子を使用する方法を示しています。#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <stdio.h>
void main(void)
{
LPWSTR pMessage = L"%1!*.*s! %4 %5!*s!";
DWORD_PTR pArgs[] = { (DWORD_PTR)4, (DWORD_PTR)2, (DWORD_PTR)L"Bill", // %1!*.*s! refers back to the first insertion string in pMessage
(DWORD_PTR)L"Bob", // %4 refers back to the second insertion string in pMessage
(DWORD_PTR)6, (DWORD_PTR)L"Bill" }; // %5!*s! refers back to the third insertion string in pMessage
const DWORD size = 100+1;
WCHAR buffer[size];
if (!FormatMessage(FORMAT_MESSAGE_FROM_STRING | FORMAT_MESSAGE_ARGUMENT_ARRAY,
pMessage,
0,
0,
buffer,
size,
(va_list*)pArgs))
{
wprintf(L"Format message failed with 0x%x\n", GetLastError());
return;
}
// Buffer contains " Bi Bob Bill".
wprintf(L"Formatted message: %s\n", buffer);
}
次の例は、前の例を va_list を使用して実装する方法を示しています。
#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <stdio.h>
LPWSTR GetFormattedMessage(LPWSTR pMessage, ...);
void main(void)
{
LPWSTR pBuffer = NULL;
LPWSTR pMessage = L"%1!*.*s! %3 %4!*s!";
// The variable length arguments correspond directly to the format
// strings in pMessage.
pBuffer = GetFormattedMessage(pMessage, 4, 2, L"Bill", L"Bob", 6, L"Bill");
if (pBuffer)
{
// Buffer contains " Bi Bob Bill".
wprintf(L"Formatted message: %s\n", pBuffer);
LocalFree(pBuffer);
}
else
{
wprintf(L"Format message failed with 0x%x\n", GetLastError());
}
}
// Formats a message string using the specified message and variable
// list of arguments.
LPWSTR GetFormattedMessage(LPWSTR pMessage, ...)
{
LPWSTR pBuffer = NULL;
va_list args = NULL;
va_start(args, pMessage);
FormatMessage(FORMAT_MESSAGE_FROM_STRING |
FORMAT_MESSAGE_ALLOCATE_BUFFER,
pMessage,
0,
0,
(LPWSTR)&pBuffer,
0,
&args);
va_end(args);
return pBuffer;
}
winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FormatMessage を定義します。エンコーディングニュートラルなエイリアスの使用を、エンコーディングニュートラルでないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
DWORD FormatMessageW(
FORMAT_MESSAGE_OPTIONS dwFlags,
const void* lpSource, // optional
DWORD dwMessageId,
DWORD dwLanguageId,
LPWSTR lpBuffer,
DWORD nSize,
CHAR** Arguments // optional
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint FormatMessageW(
uint dwFlags, // FORMAT_MESSAGE_OPTIONS
IntPtr lpSource, // void* optional
uint dwMessageId, // DWORD
uint dwLanguageId, // DWORD
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, // LPWSTR out
uint nSize, // DWORD
IntPtr Arguments // CHAR** optional
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FormatMessageW(
dwFlags As UInteger, ' FORMAT_MESSAGE_OPTIONS
lpSource As IntPtr, ' void* optional
dwMessageId As UInteger, ' DWORD
dwLanguageId As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder, ' LPWSTR out
nSize As UInteger, ' DWORD
Arguments As IntPtr ' CHAR** optional
) As UInteger
End Function' dwFlags : FORMAT_MESSAGE_OPTIONS
' lpSource : void* optional
' dwMessageId : DWORD
' dwLanguageId : DWORD
' lpBuffer : LPWSTR out
' nSize : DWORD
' Arguments : CHAR** optional
Declare PtrSafe Function FormatMessageW Lib "kernel32" ( _
ByVal dwFlags As Long, _
ByVal lpSource As LongPtr, _
ByVal dwMessageId As Long, _
ByVal dwLanguageId As Long, _
ByVal lpBuffer As LongPtr, _
ByVal nSize As Long, _
ByVal Arguments 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
FormatMessageW = ctypes.windll.kernel32.FormatMessageW
FormatMessageW.restype = wintypes.DWORD
FormatMessageW.argtypes = [
wintypes.DWORD, # dwFlags : FORMAT_MESSAGE_OPTIONS
ctypes.POINTER(None), # lpSource : void* optional
wintypes.DWORD, # dwMessageId : DWORD
wintypes.DWORD, # dwLanguageId : DWORD
wintypes.LPWSTR, # lpBuffer : LPWSTR out
wintypes.DWORD, # nSize : DWORD
ctypes.c_void_p, # Arguments : CHAR** optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
FormatMessageW = Fiddle::Function.new(
lib['FormatMessageW'],
[
-Fiddle::TYPE_INT, # dwFlags : FORMAT_MESSAGE_OPTIONS
Fiddle::TYPE_VOIDP, # lpSource : void* optional
-Fiddle::TYPE_INT, # dwMessageId : DWORD
-Fiddle::TYPE_INT, # dwLanguageId : DWORD
Fiddle::TYPE_VOIDP, # lpBuffer : LPWSTR out
-Fiddle::TYPE_INT, # nSize : DWORD
Fiddle::TYPE_VOIDP, # Arguments : CHAR** optional
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn FormatMessageW(
dwFlags: u32, // FORMAT_MESSAGE_OPTIONS
lpSource: *const (), // void* optional
dwMessageId: u32, // DWORD
dwLanguageId: u32, // DWORD
lpBuffer: *mut u16, // LPWSTR out
nSize: u32, // DWORD
Arguments: *mut *mut i8 // CHAR** optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint FormatMessageW(uint dwFlags, IntPtr lpSource, uint dwMessageId, uint dwLanguageId, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, uint nSize, IntPtr Arguments);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FormatMessageW' -Namespace Win32 -PassThru
# $api::FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)#uselib "KERNEL32.dll"
#func global FormatMessageW "FormatMessageW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; FormatMessageW dwFlags, lpSource, dwMessageId, dwLanguageId, varptr(lpBuffer), nSize, varptr(Arguments) ; 戻り値は stat
; dwFlags : FORMAT_MESSAGE_OPTIONS -> "wptr"
; lpSource : void* optional -> "wptr"
; dwMessageId : DWORD -> "wptr"
; dwLanguageId : DWORD -> "wptr"
; lpBuffer : LPWSTR out -> "wptr"
; nSize : DWORD -> "wptr"
; Arguments : CHAR** optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global FormatMessageW "FormatMessageW" int, sptr, int, int, var, int, var ; res = FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments) ; dwFlags : FORMAT_MESSAGE_OPTIONS -> "int" ; lpSource : void* optional -> "sptr" ; dwMessageId : DWORD -> "int" ; dwLanguageId : DWORD -> "int" ; lpBuffer : LPWSTR out -> "var" ; nSize : DWORD -> "int" ; Arguments : CHAR** optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global FormatMessageW "FormatMessageW" int, sptr, int, int, sptr, int, sptr ; res = FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, varptr(lpBuffer), nSize, varptr(Arguments)) ; dwFlags : FORMAT_MESSAGE_OPTIONS -> "int" ; lpSource : void* optional -> "sptr" ; dwMessageId : DWORD -> "int" ; dwLanguageId : DWORD -> "int" ; lpBuffer : LPWSTR out -> "sptr" ; nSize : DWORD -> "int" ; Arguments : CHAR** optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD FormatMessageW(FORMAT_MESSAGE_OPTIONS dwFlags, void* lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPWSTR lpBuffer, DWORD nSize, CHAR** Arguments) #uselib "KERNEL32.dll" #cfunc global FormatMessageW "FormatMessageW" int, intptr, int, int, var, int, var ; res = FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments) ; dwFlags : FORMAT_MESSAGE_OPTIONS -> "int" ; lpSource : void* optional -> "intptr" ; dwMessageId : DWORD -> "int" ; dwLanguageId : DWORD -> "int" ; lpBuffer : LPWSTR out -> "var" ; nSize : DWORD -> "int" ; Arguments : CHAR** optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD FormatMessageW(FORMAT_MESSAGE_OPTIONS dwFlags, void* lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPWSTR lpBuffer, DWORD nSize, CHAR** Arguments) #uselib "KERNEL32.dll" #cfunc global FormatMessageW "FormatMessageW" int, intptr, int, int, intptr, int, intptr ; res = FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, varptr(lpBuffer), nSize, varptr(Arguments)) ; dwFlags : FORMAT_MESSAGE_OPTIONS -> "int" ; lpSource : void* optional -> "intptr" ; dwMessageId : DWORD -> "int" ; dwLanguageId : DWORD -> "int" ; lpBuffer : LPWSTR out -> "intptr" ; nSize : DWORD -> "int" ; Arguments : CHAR** optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procFormatMessageW = kernel32.NewProc("FormatMessageW")
)
// dwFlags (FORMAT_MESSAGE_OPTIONS), lpSource (void* optional), dwMessageId (DWORD), dwLanguageId (DWORD), lpBuffer (LPWSTR out), nSize (DWORD), Arguments (CHAR** optional)
r1, _, err := procFormatMessageW.Call(
uintptr(dwFlags),
uintptr(lpSource),
uintptr(dwMessageId),
uintptr(dwLanguageId),
uintptr(lpBuffer),
uintptr(nSize),
uintptr(Arguments),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction FormatMessageW(
dwFlags: DWORD; // FORMAT_MESSAGE_OPTIONS
lpSource: Pointer; // void* optional
dwMessageId: DWORD; // DWORD
dwLanguageId: DWORD; // DWORD
lpBuffer: PWideChar; // LPWSTR out
nSize: DWORD; // DWORD
Arguments: Pointer // CHAR** optional
): DWORD; stdcall;
external 'KERNEL32.dll' name 'FormatMessageW';result := DllCall("KERNEL32\FormatMessageW"
, "UInt", dwFlags ; FORMAT_MESSAGE_OPTIONS
, "Ptr", lpSource ; void* optional
, "UInt", dwMessageId ; DWORD
, "UInt", dwLanguageId ; DWORD
, "Ptr", lpBuffer ; LPWSTR out
, "UInt", nSize ; DWORD
, "Ptr", Arguments ; CHAR** optional
, "UInt") ; return: DWORD●FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments) = DLL("KERNEL32.dll", "dword FormatMessageW(dword, void*, dword, dword, char*, dword, void*)")
# 呼び出し: FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
# dwFlags : FORMAT_MESSAGE_OPTIONS -> "dword"
# lpSource : void* optional -> "void*"
# dwMessageId : DWORD -> "dword"
# dwLanguageId : DWORD -> "dword"
# lpBuffer : LPWSTR out -> "char*"
# nSize : DWORD -> "dword"
# Arguments : CHAR** optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn FormatMessageW(
dwFlags: u32, // FORMAT_MESSAGE_OPTIONS
lpSource: ?*anyopaque, // void* optional
dwMessageId: u32, // DWORD
dwLanguageId: u32, // DWORD
lpBuffer: [*c]u16, // LPWSTR out
nSize: u32, // DWORD
Arguments: [*c][*c]i8 // CHAR** optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc FormatMessageW(
dwFlags: uint32, # FORMAT_MESSAGE_OPTIONS
lpSource: pointer, # void* optional
dwMessageId: uint32, # DWORD
dwLanguageId: uint32, # DWORD
lpBuffer: ptr uint16, # LPWSTR out
nSize: uint32, # DWORD
Arguments: ptr int8 # CHAR** optional
): uint32 {.importc: "FormatMessageW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
uint FormatMessageW(
uint dwFlags, // FORMAT_MESSAGE_OPTIONS
void* lpSource, // void* optional
uint dwMessageId, // DWORD
uint dwLanguageId, // DWORD
wchar* lpBuffer, // LPWSTR out
uint nSize, // DWORD
byte** Arguments // CHAR** optional
);ccall((:FormatMessageW, "KERNEL32.dll"), stdcall, UInt32,
(UInt32, Ptr{Cvoid}, UInt32, UInt32, Ptr{UInt16}, UInt32, Ptr{Int8}),
dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
# dwFlags : FORMAT_MESSAGE_OPTIONS -> UInt32
# lpSource : void* optional -> Ptr{Cvoid}
# dwMessageId : DWORD -> UInt32
# dwLanguageId : DWORD -> UInt32
# lpBuffer : LPWSTR out -> Ptr{UInt16}
# nSize : DWORD -> UInt32
# Arguments : CHAR** optional -> Ptr{Int8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t FormatMessageW(
uint32_t dwFlags,
void* lpSource,
uint32_t dwMessageId,
uint32_t dwLanguageId,
uint16_t* lpBuffer,
uint32_t nSize,
int8_t** Arguments);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
-- dwFlags : FORMAT_MESSAGE_OPTIONS
-- lpSource : void* optional
-- dwMessageId : DWORD
-- dwLanguageId : DWORD
-- lpBuffer : LPWSTR out
-- nSize : DWORD
-- Arguments : CHAR** optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FormatMessageW = lib.func('__stdcall', 'FormatMessageW', 'uint32_t', ['uint32_t', 'void *', 'uint32_t', 'uint32_t', 'uint16_t *', 'uint32_t', 'int8_t *']);
// FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
// dwFlags : FORMAT_MESSAGE_OPTIONS -> 'uint32_t'
// lpSource : void* optional -> 'void *'
// dwMessageId : DWORD -> 'uint32_t'
// dwLanguageId : DWORD -> 'uint32_t'
// lpBuffer : LPWSTR out -> 'uint16_t *'
// nSize : DWORD -> 'uint32_t'
// Arguments : CHAR** optional -> 'int8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
FormatMessageW: { parameters: ["u32", "pointer", "u32", "u32", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
// dwFlags : FORMAT_MESSAGE_OPTIONS -> "u32"
// lpSource : void* optional -> "pointer"
// dwMessageId : DWORD -> "u32"
// dwLanguageId : DWORD -> "u32"
// lpBuffer : LPWSTR out -> "buffer"
// nSize : DWORD -> "u32"
// Arguments : CHAR** optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t FormatMessageW(
uint32_t dwFlags,
void* lpSource,
uint32_t dwMessageId,
uint32_t dwLanguageId,
uint16_t* lpBuffer,
uint32_t nSize,
int8_t** Arguments);
C, "KERNEL32.dll");
// $ffi->FormatMessageW(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments);
// dwFlags : FORMAT_MESSAGE_OPTIONS
// lpSource : void* optional
// dwMessageId : DWORD
// dwLanguageId : DWORD
// lpBuffer : LPWSTR out
// nSize : DWORD
// Arguments : CHAR** optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
int FormatMessageW(
int dwFlags, // FORMAT_MESSAGE_OPTIONS
Pointer lpSource, // void* optional
int dwMessageId, // DWORD
int dwLanguageId, // DWORD
char[] lpBuffer, // LPWSTR out
int nSize, // DWORD
Pointer Arguments // CHAR** optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun FormatMessageW = FormatMessageW(
dwFlags : UInt32, # FORMAT_MESSAGE_OPTIONS
lpSource : Void*, # void* optional
dwMessageId : UInt32, # DWORD
dwLanguageId : UInt32, # DWORD
lpBuffer : UInt16*, # LPWSTR out
nSize : UInt32, # DWORD
Arguments : Int8** # CHAR** optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FormatMessageWNative = Uint32 Function(Uint32, Pointer<Void>, Uint32, Uint32, Pointer<Utf16>, Uint32, Pointer<Int8>);
typedef FormatMessageWDart = int Function(int, Pointer<Void>, int, int, Pointer<Utf16>, int, Pointer<Int8>);
final FormatMessageW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<FormatMessageWNative, FormatMessageWDart>('FormatMessageW');
// dwFlags : FORMAT_MESSAGE_OPTIONS -> Uint32
// lpSource : void* optional -> Pointer<Void>
// dwMessageId : DWORD -> Uint32
// dwLanguageId : DWORD -> Uint32
// lpBuffer : LPWSTR out -> Pointer<Utf16>
// nSize : DWORD -> Uint32
// Arguments : CHAR** optional -> Pointer<Int8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FormatMessageW(
dwFlags: DWORD; // FORMAT_MESSAGE_OPTIONS
lpSource: Pointer; // void* optional
dwMessageId: DWORD; // DWORD
dwLanguageId: DWORD; // DWORD
lpBuffer: PWideChar; // LPWSTR out
nSize: DWORD; // DWORD
Arguments: Pointer // CHAR** optional
): DWORD; stdcall;
external 'KERNEL32.dll' name 'FormatMessageW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FormatMessageW"
c_FormatMessageW :: Word32 -> Ptr () -> Word32 -> Word32 -> CWString -> Word32 -> Ptr Int8 -> IO Word32
-- dwFlags : FORMAT_MESSAGE_OPTIONS -> Word32
-- lpSource : void* optional -> Ptr ()
-- dwMessageId : DWORD -> Word32
-- dwLanguageId : DWORD -> Word32
-- lpBuffer : LPWSTR out -> CWString
-- nSize : DWORD -> Word32
-- Arguments : CHAR** optional -> Ptr Int8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let formatmessagew =
foreign "FormatMessageW"
(uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr uint16_t) @-> uint32_t @-> (ptr int8_t) @-> returning uint32_t)
(* dwFlags : FORMAT_MESSAGE_OPTIONS -> uint32_t *)
(* lpSource : void* optional -> (ptr void) *)
(* dwMessageId : DWORD -> uint32_t *)
(* dwLanguageId : DWORD -> uint32_t *)
(* lpBuffer : LPWSTR out -> (ptr uint16_t) *)
(* nSize : DWORD -> uint32_t *)
(* Arguments : CHAR** optional -> (ptr int8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("FormatMessageW" format-message-w :convention :stdcall) :uint32
(dw-flags :uint32) ; FORMAT_MESSAGE_OPTIONS
(lp-source :pointer) ; void* optional
(dw-message-id :uint32) ; DWORD
(dw-language-id :uint32) ; DWORD
(lp-buffer :pointer) ; LPWSTR out
(n-size :uint32) ; DWORD
(arguments :pointer)) ; CHAR** optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FormatMessageW = Win32::API::More->new('KERNEL32',
'DWORD FormatMessageW(DWORD dwFlags, LPVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPWSTR lpBuffer, DWORD nSize, LPVOID Arguments)');
# my $ret = $FormatMessageW->Call($dwFlags, $lpSource, $dwMessageId, $dwLanguageId, $lpBuffer, $nSize, $Arguments);
# dwFlags : FORMAT_MESSAGE_OPTIONS -> DWORD
# lpSource : void* optional -> LPVOID
# dwMessageId : DWORD -> DWORD
# dwLanguageId : DWORD -> DWORD
# lpBuffer : LPWSTR out -> LPWSTR
# nSize : DWORD -> DWORD
# Arguments : CHAR** optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f FormatMessageA (ANSI版) — メッセージ文字列を整形して取得する(ANSI版)。