Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › FormatMessageA

FormatMessageA

関数
メッセージ文字列を整形して取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD FormatMessageA(
    FORMAT_MESSAGE_OPTIONS dwFlags,
    const void* lpSource,   // optional
    DWORD dwMessageId,
    DWORD dwLanguageId,
    LPSTR lpBuffer,
    DWORD nSize,
    CHAR** Arguments   // optional
);

パラメーター

名前方向説明
dwFlagsFORMAT_MESSAGE_OPTIONSin

書式設定オプション、および lpSource パラメーターの解釈方法を指定します。dwFlags の 下位バイトは、出力バッファー内の改行を関数がどのように扱うかを指定します。下位バイトでは、 書式設定された出力行の最大幅も指定できます。

このパラメーターには、次の値を 1 つ以上指定できます。

意味
FORMAT_MESSAGE_ALLOCATE_BUFFER
0x00000100
関数は書式設定されたメッセージを格納するのに十分な大きさのバッファーを割り当て、割り当てた バッファーへのポインターを lpBuffer で指定されたアドレスに格納します。 lpBuffer パラメーターは LPTSTR へのポインターであり、ポインターを LPTSTR にキャストする必要があります(例: (LPTSTR)&lpBuffer)。nSize パラメーターは、出力メッセージバッファーに割り当てる TCHAR の最小数を指定します。 呼び出し元は、バッファーが不要になったら LocalFree 関数を使用してバッファーを解放する必要があります。

書式設定されたメッセージの長さが 128K バイトを超える場合、 FormatMessage は失敗し、その後の GetLastError の呼び出しは ERROR_MORE_DATA を返します。

以前のバージョンの Windows では、この値は Windows ストアアプリのコンパイル時には使用できませんでした。Windows 10 以降では、この値を使用できます。

Windows Server 2003 および Windows XP:

書式設定されたメッセージの長さが 128K バイトを超える場合でも、 FormatMessageERROR_MORE_DATA エラーで 自動的に失敗することはありません。

FORMAT_MESSAGE_ARGUMENT_ARRAY
0x00002000
Arguments パラメーターは va_list 構造体ではなく、引数を表す値の配列へのポインターです。

このフラグは 64 ビット整数値とともに使用することはできません。64 ビット整数を使用する場合は、 va_list 構造体を使用する必要があります。

FORMAT_MESSAGE_FROM_HMODULE
0x00000800
lpSource パラメーターは、検索対象のメッセージテーブルリソースを含む モジュールハンドルです。この lpSource ハンドルが NULL の場合、 現在のプロセスのアプリケーションイメージファイルが検索されます。このフラグは FORMAT_MESSAGE_FROM_STRING とともに使用することはできません。

モジュールにメッセージテーブルリソースがない場合、関数は ERROR_RESOURCE_TYPE_NOT_FOUND で失敗します。

FORMAT_MESSAGE_FROM_STRING
0x00000400
lpSource パラメーターは、メッセージ定義を含む null 終端文字列への ポインターです。メッセージ定義には、メッセージテーブルリソース内のメッセージテキストと同様に、 挿入シーケンスを含めることができます。このフラグは FORMAT_MESSAGE_FROM_HMODULE または FORMAT_MESSAGE_FROM_SYSTEM とともに使用することはできません。
FORMAT_MESSAGE_FROM_SYSTEM
0x00001000
関数は、要求されたメッセージをシステムメッセージテーブルリソースから検索します。このフラグが FORMAT_MESSAGE_FROM_HMODULE とともに指定された場合、関数は lpSource で指定されたモジュール内でメッセージが見つからないときにシステム メッセージテーブルを検索します。このフラグは FORMAT_MESSAGE_FROM_STRING とともに 使用することはできません。

このフラグが指定されている場合、アプリケーションは GetLastError 関数の結果を渡して、 システム定義エラーのメッセージテキストを取得できます。

FORMAT_MESSAGE_IGNORE_INSERTS
0x00000200
%1 などのメッセージ定義内の挿入シーケンスは無視され、変更されずに出力バッファーへ 渡されます。このフラグは、後で書式設定するためにメッセージを取得する場合に便利です。このフラグが 設定されている場合、Arguments パラメーターは無視されます。

dwFlags の下位バイトでは、書式設定された出力行の最大幅を 指定できます。下位バイトに指定できる値は次のとおりです。

意味
0
出力行の幅に制限はありません。関数は、メッセージ定義テキスト内にある改行を 出力バッファーに格納します。
FORMAT_MESSAGE_MAX_WIDTH_MASK
0x000000FF
関数は、メッセージ定義テキスト内の通常の改行を無視します。関数は、メッセージ定義テキスト内の ハードコードされた改行を出力バッファーに格納します。関数は新しい改行を生成しません。

下位バイトが FORMAT_MESSAGE_MAX_WIDTH_MASK 以外の 0 でない値の場合、 その値は出力行内の最大文字数を指定します。関数は、メッセージ定義テキスト内の通常の改行を無視します。 関数は、空白で区切られた文字列を改行で分割することは決してありません。関数は、メッセージ定義テキスト内の ハードコードされた改行を出力バッファーに格納します。ハードコードされた改行は %n エスケープシーケンスで コーディングされます。

lpSourcevoid*inoptional

メッセージ定義の場所です。このパラメーターの型は、 dwFlags パラメーターの設定によって異なります。

dwFlags の設定 意味
FORMAT_MESSAGE_FROM_HMODULE
0x00000800
検索対象のメッセージテーブルを含むモジュールへのハンドルです。
FORMAT_MESSAGE_FROM_STRING
0x00000400
書式設定されていないメッセージテキストで構成される文字列へのポインターです。挿入のためにスキャンされ、 それに従って書式設定されます。

これらのフラグのいずれも dwFlags に設定されていない場合、 lpSource は無視されます。

dwMessageIdDWORDin要求されたメッセージのメッセージ識別子です。dwFlagsFORMAT_MESSAGE_FROM_STRING が含まれている場合、このパラメーターは無視されます。
dwLanguageIdDWORDin

要求されたメッセージの 言語識別子 です。 dwFlagsFORMAT_MESSAGE_FROM_STRING が含まれている場合、 このパラメーターは無視されます。

このパラメーターに特定の LANGID を渡すと、 FormatMessage はその LANGID のメッセージのみを返します。 その LANGID のメッセージが見つからない場合、Last-Error を ERROR_RESOURCE_LANG_NOT_FOUND に設定します。0 を渡すと、 FormatMessage は次の順序で LANGID のメッセージを 検索します。

  1. 言語ニュートラル
  2. スレッドの LANGID(スレッドのロケール値に基づく)
  3. ユーザー既定の LANGID(ユーザーの既定ロケール値に基づく)
  4. システム既定の LANGID(システムの既定ロケール値に基づく)
  5. 米国英語
FormatMessage が上記のいずれの LANGID に対しても メッセージを見つけられない場合、存在する任意の言語のメッセージ文字列を返します。 それも失敗した場合は、ERROR_RESOURCE_LANG_NOT_FOUND を返します。
lpBufferLPSTRout

書式設定されたメッセージを指定する null 終端文字列を受け取るバッファーへのポインターです。 dwFlagsFORMAT_MESSAGE_ALLOCATE_BUFFER が含まれている場合、 関数は LocalAlloc 関数を使用して バッファーを割り当て、バッファーへのポインターを lpBuffer で指定されたアドレスに 格納します。

このバッファーは 64K バイトを超えることはできません。

nSizeDWORDin

FORMAT_MESSAGE_ALLOCATE_BUFFER フラグが設定されていない場合、このパラメーターは 出力バッファーのサイズを TCHAR 単位で指定します。 FORMAT_MESSAGE_ALLOCATE_BUFFER が設定されている場合、このパラメーターは 出力バッファーに割り当てる TCHAR の最小数を指定します。

出力バッファーは 64K バイトを超えることはできません。

ArgumentsCHAR**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

公式ドキュメント

メッセージ文字列を書式設定します。(FormatMessageA)

戻り値

関数が成功した場合、戻り値は終端の null 文字を除いて、出力バッファーに格納された TCHAR の数です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 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!" の場合、引数は 4、2、Bill、Bob、6、Bill とすることができます(FORMAT_MESSAGE_ARGUMENT_ARRAY フラグを使用する場合)。 書式設定された文字列は " 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 によって返される システムエラーコードに対するエラーメッセージ文字列を取得できます。例については、 最終エラーコードの取得 を参照してください。

次の例は、引数配列と幅および精度の指定子の使用方法を示しています。
#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 ヘッダーは FormatMessage を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディングニュートラルなエイリアスの使用を、エンコーディングニュートラルでないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規約 を参照してください。

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

各言語での呼び出し定義

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

DWORD FormatMessageA(
    FORMAT_MESSAGE_OPTIONS dwFlags,
    const void* lpSource,   // optional
    DWORD dwMessageId,
    DWORD dwLanguageId,
    LPSTR lpBuffer,
    DWORD nSize,
    CHAR** Arguments   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint FormatMessageA(
    uint dwFlags,   // FORMAT_MESSAGE_OPTIONS
    IntPtr lpSource,   // void* optional
    uint dwMessageId,   // DWORD
    uint dwLanguageId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer,   // LPSTR out
    uint nSize,   // DWORD
    IntPtr Arguments   // CHAR** optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FormatMessageA(
    dwFlags As UInteger,   ' FORMAT_MESSAGE_OPTIONS
    lpSource As IntPtr,   ' void* optional
    dwMessageId As UInteger,   ' DWORD
    dwLanguageId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpBuffer As System.Text.StringBuilder,   ' LPSTR 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 : LPSTR out
' nSize : DWORD
' Arguments : CHAR** optional
Declare PtrSafe Function FormatMessageA Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpSource As LongPtr, _
    ByVal dwMessageId As Long, _
    ByVal dwLanguageId As Long, _
    ByVal lpBuffer As String, _
    ByVal nSize As Long, _
    ByVal Arguments As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FormatMessageA = ctypes.windll.kernel32.FormatMessageA
FormatMessageA.restype = wintypes.DWORD
FormatMessageA.argtypes = [
    wintypes.DWORD,  # dwFlags : FORMAT_MESSAGE_OPTIONS
    ctypes.POINTER(None),  # lpSource : void* optional
    wintypes.DWORD,  # dwMessageId : DWORD
    wintypes.DWORD,  # dwLanguageId : DWORD
    wintypes.LPSTR,  # lpBuffer : LPSTR 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')
FormatMessageA = Fiddle::Function.new(
  lib['FormatMessageA'],
  [
    -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 : LPSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # Arguments : CHAR** optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn FormatMessageA(
        dwFlags: u32,  // FORMAT_MESSAGE_OPTIONS
        lpSource: *const (),  // void* optional
        dwMessageId: u32,  // DWORD
        dwLanguageId: u32,  // DWORD
        lpBuffer: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern uint FormatMessageA(uint dwFlags, IntPtr lpSource, uint dwMessageId, uint dwLanguageId, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer, uint nSize, IntPtr Arguments);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FormatMessageA' -Namespace Win32 -PassThru
# $api::FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
#uselib "KERNEL32.dll"
#func global FormatMessageA "FormatMessageA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; FormatMessageA dwFlags, lpSource, dwMessageId, dwLanguageId, varptr(lpBuffer), nSize, varptr(Arguments)   ; 戻り値は stat
; dwFlags : FORMAT_MESSAGE_OPTIONS -> "sptr"
; lpSource : void* optional -> "sptr"
; dwMessageId : DWORD -> "sptr"
; dwLanguageId : DWORD -> "sptr"
; lpBuffer : LPSTR out -> "sptr"
; nSize : DWORD -> "sptr"
; Arguments : CHAR** optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global FormatMessageA "FormatMessageA" int, sptr, int, int, var, int, var
; res = FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
; dwFlags : FORMAT_MESSAGE_OPTIONS -> "int"
; lpSource : void* optional -> "sptr"
; dwMessageId : DWORD -> "int"
; dwLanguageId : DWORD -> "int"
; lpBuffer : LPSTR out -> "var"
; nSize : DWORD -> "int"
; Arguments : CHAR** optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD FormatMessageA(FORMAT_MESSAGE_OPTIONS dwFlags, void* lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPSTR lpBuffer, DWORD nSize, CHAR** Arguments)
#uselib "KERNEL32.dll"
#cfunc global FormatMessageA "FormatMessageA" int, intptr, int, int, var, int, var
; res = FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
; dwFlags : FORMAT_MESSAGE_OPTIONS -> "int"
; lpSource : void* optional -> "intptr"
; dwMessageId : DWORD -> "int"
; dwLanguageId : DWORD -> "int"
; lpBuffer : LPSTR out -> "var"
; nSize : DWORD -> "int"
; Arguments : CHAR** optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFormatMessageA = kernel32.NewProc("FormatMessageA")
)

// dwFlags (FORMAT_MESSAGE_OPTIONS), lpSource (void* optional), dwMessageId (DWORD), dwLanguageId (DWORD), lpBuffer (LPSTR out), nSize (DWORD), Arguments (CHAR** optional)
r1, _, err := procFormatMessageA.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   // DWORD
function FormatMessageA(
  dwFlags: DWORD;   // FORMAT_MESSAGE_OPTIONS
  lpSource: Pointer;   // void* optional
  dwMessageId: DWORD;   // DWORD
  dwLanguageId: DWORD;   // DWORD
  lpBuffer: PAnsiChar;   // LPSTR out
  nSize: DWORD;   // DWORD
  Arguments: Pointer   // CHAR** optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'FormatMessageA';
result := DllCall("KERNEL32\FormatMessageA"
    , "UInt", dwFlags   ; FORMAT_MESSAGE_OPTIONS
    , "Ptr", lpSource   ; void* optional
    , "UInt", dwMessageId   ; DWORD
    , "UInt", dwLanguageId   ; DWORD
    , "Ptr", lpBuffer   ; LPSTR out
    , "UInt", nSize   ; DWORD
    , "Ptr", Arguments   ; CHAR** optional
    , "UInt")   ; return: DWORD
●FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments) = DLL("KERNEL32.dll", "dword FormatMessageA(dword, void*, dword, dword, char*, dword, void*)")
# 呼び出し: FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
# dwFlags : FORMAT_MESSAGE_OPTIONS -> "dword"
# lpSource : void* optional -> "void*"
# dwMessageId : DWORD -> "dword"
# dwLanguageId : DWORD -> "dword"
# lpBuffer : LPSTR out -> "char*"
# nSize : DWORD -> "dword"
# Arguments : CHAR** optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn FormatMessageA(
    dwFlags: u32, // FORMAT_MESSAGE_OPTIONS
    lpSource: ?*anyopaque, // void* optional
    dwMessageId: u32, // DWORD
    dwLanguageId: u32, // DWORD
    lpBuffer: [*c]u8, // LPSTR out
    nSize: u32, // DWORD
    Arguments: [*c][*c]i8 // CHAR** optional
) callconv(std.os.windows.WINAPI) u32;
proc FormatMessageA(
    dwFlags: uint32,  # FORMAT_MESSAGE_OPTIONS
    lpSource: pointer,  # void* optional
    dwMessageId: uint32,  # DWORD
    dwLanguageId: uint32,  # DWORD
    lpBuffer: ptr char,  # LPSTR out
    nSize: uint32,  # DWORD
    Arguments: ptr int8  # CHAR** optional
): uint32 {.importc: "FormatMessageA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint FormatMessageA(
    uint dwFlags,   // FORMAT_MESSAGE_OPTIONS
    void* lpSource,   // void* optional
    uint dwMessageId,   // DWORD
    uint dwLanguageId,   // DWORD
    char* lpBuffer,   // LPSTR out
    uint nSize,   // DWORD
    byte** Arguments   // CHAR** optional
);
ccall((:FormatMessageA, "KERNEL32.dll"), stdcall, UInt32,
      (UInt32, Ptr{Cvoid}, UInt32, UInt32, Ptr{UInt8}, 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 : LPSTR out -> Ptr{UInt8}
# nSize : DWORD -> UInt32
# Arguments : CHAR** optional -> Ptr{Int8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t FormatMessageA(
    uint32_t dwFlags,
    void* lpSource,
    uint32_t dwMessageId,
    uint32_t dwLanguageId,
    char* lpBuffer,
    uint32_t nSize,
    int8_t** Arguments);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
-- dwFlags : FORMAT_MESSAGE_OPTIONS
-- lpSource : void* optional
-- dwMessageId : DWORD
-- dwLanguageId : DWORD
-- lpBuffer : LPSTR out
-- nSize : DWORD
-- Arguments : CHAR** optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FormatMessageA = lib.func('__stdcall', 'FormatMessageA', 'uint32_t', ['uint32_t', 'void *', 'uint32_t', 'uint32_t', 'char *', 'uint32_t', 'int8_t *']);
// FormatMessageA(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 : LPSTR out -> 'char *'
// nSize : DWORD -> 'uint32_t'
// Arguments : CHAR** optional -> 'int8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  FormatMessageA: { parameters: ["u32", "pointer", "u32", "u32", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments)
// dwFlags : FORMAT_MESSAGE_OPTIONS -> "u32"
// lpSource : void* optional -> "pointer"
// dwMessageId : DWORD -> "u32"
// dwLanguageId : DWORD -> "u32"
// lpBuffer : LPSTR out -> "buffer"
// nSize : DWORD -> "u32"
// Arguments : CHAR** optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t FormatMessageA(
    uint32_t dwFlags,
    void* lpSource,
    uint32_t dwMessageId,
    uint32_t dwLanguageId,
    char* lpBuffer,
    uint32_t nSize,
    int8_t** Arguments);
C, "KERNEL32.dll");
// $ffi->FormatMessageA(dwFlags, lpSource, dwMessageId, dwLanguageId, lpBuffer, nSize, Arguments);
// dwFlags : FORMAT_MESSAGE_OPTIONS
// lpSource : void* optional
// dwMessageId : DWORD
// dwLanguageId : DWORD
// lpBuffer : LPSTR 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.ASCII_OPTIONS);
    int FormatMessageA(
        int dwFlags,   // FORMAT_MESSAGE_OPTIONS
        Pointer lpSource,   // void* optional
        int dwMessageId,   // DWORD
        int dwLanguageId,   // DWORD
        byte[] lpBuffer,   // LPSTR out
        int nSize,   // DWORD
        Pointer Arguments   // CHAR** optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun FormatMessageA = FormatMessageA(
    dwFlags : UInt32,   # FORMAT_MESSAGE_OPTIONS
    lpSource : Void*,   # void* optional
    dwMessageId : UInt32,   # DWORD
    dwLanguageId : UInt32,   # DWORD
    lpBuffer : UInt8*,   # LPSTR 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 FormatMessageANative = Uint32 Function(Uint32, Pointer<Void>, Uint32, Uint32, Pointer<Utf8>, Uint32, Pointer<Int8>);
typedef FormatMessageADart = int Function(int, Pointer<Void>, int, int, Pointer<Utf8>, int, Pointer<Int8>);
final FormatMessageA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FormatMessageANative, FormatMessageADart>('FormatMessageA');
// dwFlags : FORMAT_MESSAGE_OPTIONS -> Uint32
// lpSource : void* optional -> Pointer<Void>
// dwMessageId : DWORD -> Uint32
// dwLanguageId : DWORD -> Uint32
// lpBuffer : LPSTR out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// Arguments : CHAR** optional -> Pointer<Int8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FormatMessageA(
  dwFlags: DWORD;   // FORMAT_MESSAGE_OPTIONS
  lpSource: Pointer;   // void* optional
  dwMessageId: DWORD;   // DWORD
  dwLanguageId: DWORD;   // DWORD
  lpBuffer: PAnsiChar;   // LPSTR out
  nSize: DWORD;   // DWORD
  Arguments: Pointer   // CHAR** optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'FormatMessageA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FormatMessageA"
  c_FormatMessageA :: Word32 -> Ptr () -> Word32 -> Word32 -> CString -> Word32 -> Ptr Int8 -> IO Word32
-- dwFlags : FORMAT_MESSAGE_OPTIONS -> Word32
-- lpSource : void* optional -> Ptr ()
-- dwMessageId : DWORD -> Word32
-- dwLanguageId : DWORD -> Word32
-- lpBuffer : LPSTR out -> CString
-- nSize : DWORD -> Word32
-- Arguments : CHAR** optional -> Ptr Int8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let formatmessagea =
  foreign "FormatMessageA"
    (uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> string @-> 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 : LPSTR out -> string *)
(* 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 ("FormatMessageA" format-message-a :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)   ; LPSTR 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 $FormatMessageA = Win32::API::More->new('KERNEL32',
    'DWORD FormatMessageA(DWORD dwFlags, LPVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPSTR lpBuffer, DWORD nSize, LPVOID Arguments)');
# my $ret = $FormatMessageA->Call($dwFlags, $lpSource, $dwMessageId, $dwLanguageId, $lpBuffer, $nSize, $Arguments);
# dwFlags : FORMAT_MESSAGE_OPTIONS -> DWORD
# lpSource : void* optional -> LPVOID
# dwMessageId : DWORD -> DWORD
# dwLanguageId : DWORD -> DWORD
# lpBuffer : LPSTR out -> LPSTR
# nSize : DWORD -> DWORD
# Arguments : CHAR** optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型