FormatMessage 関数 (winbase.h)

  • [アーティクル]

メッセージ文字列を書式設定します。 関数には、入力としてメッセージ定義が必要です。 メッセージ定義は、 関数に渡されたバッファーから取得できます。 これは、既に読み込まれているモジュール内のメッセージ テーブル リソースから取得できます。 または、呼び出し元は、システムのメッセージ テーブル リソースでメッセージ定義を検索するように関数に依頼できます。 関数は、メッセージ識別子と言語識別子に基づいて、メッセージ テーブル リソース内のメッセージ定義を検索します。 関数は、書式設定されたメッセージ テキストを出力バッファーにコピーし、要求された場合は埋め込み挿入シーケンスを処理します。

構文

DWORD FormatMessage(
  [in]           DWORD   dwFlags,
  [in, optional] LPCVOID lpSource,
  [in]           DWORD   dwMessageId,
  [in]           DWORD   dwLanguageId,
  [out]          LPTSTR  lpBuffer,
  [in]           DWORD   nSize,
  [in, optional] va_list *Arguments
);

パラメーター

[in] dwFlags

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

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

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

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

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

Windows Server 2003 および Windows XP:

書式設定されたメッセージの長さが 128,000 バイトを超える場合、 FormatMessage は自動的に失敗せず、 エラー ERROR_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 エスケープ シーケンスでコード化されます。

[in, optional] lpSource

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

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

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

[in] dwMessageId

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

[in] dwLanguageId

要求されたメッセージの 言語識別子 。 dwFlags にFORMAT_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を返します。

[out] lpBuffer

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

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

[in] nSize

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

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

[in, optional] Arguments

書式設定されたメッセージの挿入値として使用される値の配列。 書式指定文字列の %1 は 、Arguments 配列の最初の値を示します。%2 は 2 番目の引数を示します。などなど。

各値の解釈は、メッセージ定義の挿入に関連付けられている書式設定情報によって異なります。 既定値は、各値を null で終わる文字列へのポインターとして扱うことです。

既定では、 Arguments パラメーターの型は va_list*です。これは、可変個の引数を記述するための言語および実装固有のデータ型です。 va_list引数の状態は、 関数から戻ると未定義です。 va_listをもう一度使用するには、va_end を使用して可変引数リスト ポインターを破棄し、va_startで再初期化します。

va_list* 型のポインターがない場合は、FORMAT_MESSAGE_ARGUMENT_ARRAY フラグを指定し、DWORD_PTR値の配列へのポインターを渡します。これらの値は、挿入値として書式設定されたメッセージに入力されます。 各挿入には、配列内に対応する要素が必要です。

戻り値

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

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

メッセージ テキスト内では、メッセージを動的に書式設定するための複数のエスケープ シーケンスがサポートされています。 これらのエスケープ シーケンスとその意味を次の表に示します。 すべてのエスケープ シーケンスはパーセント文字 (%) で始まります。

エスケープ シーケンス 意味
%0 末尾の改行文字を含まないメッセージ テキスト行を終了します。 このエスケープ シーケンスを使用すると、長い行を作成したり、末尾の改行文字なしでメッセージ自体を終了したりできます。 これは、プロンプト メッセージに役立ちます。
%n!format string! 挿入シーケンスを識別します。 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 を使用する方が簡単な場合があることに注意してください。
 

パーセント文字の後に続く他の非デジタル文字は、パーセント文字なしで出力メッセージに書式設定されます。 次は一部の例です。

[書式設定文字列] 結果の出力
%% 1 つのパーセント記号。
%b 1 つのスペース。 この書式指定文字列は、メッセージ テキスト行の末尾のスペースの適切な数を確保するために使用できます。
%. 1 つの期間。 この書式指定文字列を使用すると、メッセージ テキスト定義を終了することなく、行の先頭に 1 つのピリオドを含めることができます。
%! 単一の感嘆符。 この書式指定文字列は、書式指定文字列の先頭と間違えることなく、挿入直後に感嘆符を含めるために使用できます。
%n 書式指定文字列が行の末尾に出現する場合のハード改行。 この書式指定文字列は、メッセージが一定の幅に収まるように 、FormatMessage が通常の改行を指定している場合に便利です。
%r 末尾の改行文字を含まないハード キャリッジ リターン。
%t 1 つのタブ。
 

セキュリティに関する備考

この関数が 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;
}

要件

要件 値
サポートされている最小のクライアント Windows XP [デスクトップ アプリ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

エラー処理関数

メッセージ コンパイラ

メッセージ テーブル