vsnprintf、 _vsnprintf、 _vsnprintf_l、 _vsnwprintf、 _vsnwprintf_l

引数リストへのポインターを使用して、書式付き出力を書き込みます。 これらの関数のセキュリティを強化したバージョンを使用できます。「vsnprintf_s、_vsnprintf_s、_vsnprintf_s_l、_vsnwprintf_s、_vsnwprintf_s_l」を参照してください。

構文

int vsnprintf(
   char *buffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf(
   char *buffer,
   size_t count,
   const char *format,
   va_list argptr
);

int _vsnprintf_l(
   char *buffer,
   size_t count,
   const char *format,
   _locale_t locale,
   va_list argptr
);

int _vsnwprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr
);

int _vsnwprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
);

template <size_t size>
int vsnprintf(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnprintf(
   char (&buffer)[size],
   size_t count,
   const char *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnprintf_l(
   char (&buffer)[size],
   size_t count,
   const char *format,
   _locale_t locale,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnwprintf(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   va_list argptr
); // C++ only

template <size_t size>
int _vsnwprintf_l(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
); // C++ only

パラメーター

buffer
出力の格納位置。

count
書き込む最大文字数。 wchar_tを受け取る関数の場合、書き込むワイド文字の数です。

format
書式の指定。

argptr
引数リストへのポインター。

locale
使用するロケール。

詳細については、「書式指定構文」を参照してください。

戻り値

終了 NULLを含まない、書き込まれた文字数。出力エラーが発生した場合は負の値。

詳細については、 Behavior の概要 を参照してください。

解説

これらの各関数では、引数リストへのポインターを使用して、データを書式化して、buffer が指すメモリに count 文字までを書き込みます。 vsnprintf 関数は、出力が切り捨てられる場合でも常に null 終端記号を書き込みます。 _vsnprintfと_vsnwprintfを使用する場合、バッファーは末尾に空き領域がある場合 (つまり、書き込む文字数がcount未満の場合) にのみ null で終了します。

Visual Studio 2015 および Windows 10 で UCRT と共に開始する場合、 vsnprintf は _vsnprintfと同一ではなくなります。 vsnprintf関数は C99 標準に準拠しています。_vsnprintfは古いコードとの下位互換性のために保持されます。 違いは、バッファーが不足した場合、 vsnprintf はバッファーの末尾を null で終了し、必要な文字数を返しますが、 _vsnprintf はバッファーを null 終了せず、-1 を返します。 また、 _vsnprintf() はバッファーを null で終了しないため、出力にもう 1 つの文字が含まれます。

重要

特定の種類のセキュリティ リスクを防ぐには、 format がユーザー定義文字列でないことを確認します。 詳細については、「バッファー オーバーランの回避」を参照してください。 Windows 10 バージョン 2004 (ビルド 19041) 以降の printf ファミリの関数では、丸め処理の IEEE 754 の規則に従って、正確に表現可能な浮動小数点数が出力されます。 以前のバージョンの Windows では、"5" で終わる正確に表現可能な浮動小数点数は常に切り上げられていました。 IEEE 754 では、最も近い偶数に丸める ("銀行型丸め" とも呼ばれます) 必要があることが示されています。 たとえば、printf("%1.0f", 1.5) と printf("%1.0f", 2.5) の両方を 2 に丸める必要があります。 以前は、1.5 は 2 に、2.5 は 3 に丸められていました。 この変更は、正確に表現可能な数値にのみ影響します。 たとえば、2.35 (メモリで表される場合は 2.35000000000000008 に近い) は、2.4 に切り上げられます。 これらの関数によって実行される丸め処理では、fesetround によって設定された浮動小数点丸めモードにも従うようになりました。 以前は、丸め処理には常に FE_TONEAREST の動作が選択されていました。 この変更は、Visual Studio 2019 バージョン 16.2 以降を使用してビルドされたプログラムにのみ影響します。 従来の浮動小数点丸め動作を使用するには、'legacy_stdio_float_rounding.obj' にリンクします。

Note

_vsnprintf、_vsnprintf_l、_vsnwprintf、_vsnwprintf_lを呼び出すときに、終端の null 用の空きを確保するために、count を必ずバッファー長未満にし、この関数を呼び出す前にバッファーを null に初期化してください。

vsnprintfは常に終端の null を書き込むため、count パラメーターはバッファーのサイズと等しい場合があります。

これらの関数のうち _l サフィックスが付けられたバージョンは、現在のスレッド ロケールの代わりに渡されたロケール パラメーターを使用する点を除いて同じです。

C++ では、これらの関数にテンプレートのオーバーロードがあります。このオーバーロードは、これらの関数に対応するセキュリティで保護された新しい関数を呼び出します。 詳細については、「セキュリティ保護されたテンプレート オーバーロード」を参照してください。

動作の概要

次の表の場合:

• sizeOfBufferbufferのサイズにします。 関数が char バッファーを受け取る場合、サイズはバイト単位です。 関数が wchar_t バッファーを受け取る場合、サイズは 16 ビットワードの数を指定します。
• 書式設定されたデータのサイズ len します。 関数が char バッファーを受け取る場合、サイズはバイト単位です。 関数が wchar_t バッファーを受け取る場合、サイズは 16 ビットワードの数を指定します。
• 文字とは、char バッファーを受け取る関数のchar文字と、wchar_t バッファーを受け取る関数のwchar_t文字を指します。
• 無効なパラメーター ハンドラーの詳細については、「 パラメーターの検証を参照してください。

条件	Behavior	戻り値	errno	無効なパラメーター ハンドラーを呼び出す
成功	指定した書式指定文字列を使用して、バッファーに文字を書き込みます。	終端の null 文字をカウントしない、書き込まれた文字数。	該当なし	いいえ
書式設定中のエンコード エラー	文字列指定子 s、 S、または Zを処理すると、書式指定処理が停止します。	-1	EILSEQ (42)	いいえ
書式設定中のエンコード エラー	文字指定子の処理 c または C場合、無効な文字はスキップされます。 書き込まれた文字数は、スキップされた文字に対してインクリメントされず、データも書き込まれません。 書式指定の処理は、エンコード エラーで指定子をスキップした後も続行されます。	終了 NULLを含まない、書き込まれた文字数。	EILSEQ (42)	いいえ
buffer == NULL および count != 0	無効なパラメーター ハンドラーの実行後も実行が続行される場合は、 errno を設定し、負の値を返します。	-1	EINVAL (22)	はい
count == 0	データが書き込まれない	終了 NULLを含まない、書き込まれた文字数。 この結果を使用して、文字列と終了 NULLに十分なバッファー領域を割り当て、関数を再度呼び出してバッファーを埋めることができます。	該当なし	いいえ
count < 0	Unsafe: 値は符号なしとして扱われ、バッファーに続くメモリが上書きされる大きな値が作成される可能性があります。	書き込まれる文字数です。	該当なし	いいえ
count < sizeOfBuffer および len <= count	すべてのデータが書き込まれ、終了 NULL が追加されます。	終了 NULLを含まない、書き込まれた文字数。	該当なし	いいえ
count < sizeOfBuffer および len > count	最初の count-1 文字の後に null 終端記号が書き込まれます。	書き込まれた文字の数が、null ターミネータを含まない、出力する文字数と一致 count 。	該当なし	いいえ
count >= sizeOfBuffer および len < sizeOfBuffer	すべてのデータは、終了 NULLで書き込まれます。	終了 NULLを含まない、書き込まれた文字数。	該当なし	いいえ
count >= sizeOfBuffer および len >= sizeOfBuffer	Unsafe: バッファーの後のメモリを上書きします。	終了 NULLを含まない、書き込まれた文字数。	該当なし	いいえ
format == NULL	データは書き込みされません。 無効なパラメーター ハンドラーの実行後も実行が続行される場合は、 errno を設定し、負の値を返します。	-1	EINVAL (22)	はい

これらのエラー コードおよびその他のエラー コードの詳細については、「_doserrno、errno、_sys_errlist、_sys_nerr」を参照してください。

汎用テキスト ルーチンのマップ

TCHAR.H ルーチン	_UNICODE と _MBCS が定義されていない	_MBCS が定義されている	_UNICODE が定義されている
_vsntprintf	_vsnprintf	_vsnprintf	_vsnwprintf
_vsntprintf_l	_vsnprintf_l	_vsnprintf_l	_vsnwprintf_l

要件

ルーチンによって返される値	必須ヘッダー (C)	必須ヘッダー (C++)
vsnprintf、 _vsnprintf、 _vsnprintf_l	<stdio.h>	<stdio.h> または <cstdio>
_vsnwprintf, _vsnwprintf_l	<stdio.h> または <wchar.h>	<stdio.h>、<wchar.h>、<cstdio> または <cwchar>

_vsnprintf、_vsnprintf_l、_vsnwprintf、_vsnwprintf_l の各関数は、Microsoft 固有の関数です。 互換性の詳細については、「 Compatibility」を参照してください。

例: _vsnwprintf() でワイド文字を使用する

// crt_vsnwprintf.c
// compile by using: cl /W3 crt_vsnwprintf.c

// To turn off error C4996, define this symbol:
#define _CRT_SECURE_NO_WARNINGS

#include <stdio.h>
#include <wtypes.h>

#define BUFFCOUNT (10)

void FormatOutput(LPCWSTR formatstring, ...)
{
    int nSize = 0;
    wchar_t buff[BUFFCOUNT];
    memset(buff, 0, sizeof(buff));
    va_list args;
    va_start(args, formatstring);
    // Note: _vsnwprintf is deprecated; consider vsnwprintf_s instead
    nSize = _vsnwprintf(buff, BUFFCOUNT - 1, formatstring, args); // C4996
    wprintf(L"nSize: %d, buff: %ls\n", nSize, buff);
    va_end(args);
}

int main() {
    FormatOutput(L"%ls %ls", L"Hi", L"there");
    FormatOutput(L"%ls %ls", L"Hi", L"there!");
    FormatOutput(L"%ls %ls", L"Hi", L"there!!");
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: -1, buff: Hi there!

代わりに vsnprintf を使用し、パラメータに小さな文字列を指定すると、挙動が変化します。 count パラメーターにはバッファー全体のサイズを指定でき、戻り値は count が十分大きかった場合に書き込まれていた文字数になります。

例: ナロー文字列で vsnprintf() を使用する

// crt_vsnprintf.c
// compile by using: cl /W4 crt_vsnprintf.c
#include <stdio.h>
#include <stdarg.h> // for va_list, va_start
#include <string.h> // for memset

#define BUFFCOUNT (10)

void FormatOutput(char* formatstring, ...)
{
    int nSize = 0;
    char buff[BUFFCOUNT];
    memset(buff, 0, sizeof(buff));
    va_list args;
    va_start(args, formatstring);
    nSize = vsnprintf(buff, sizeof(buff), formatstring, args);
    printf("nSize: %d, buff: %s\n", nSize, buff);
    va_end(args);
}

int main() {
    FormatOutput("%s %s", "Hi", "there");   //  8 chars + null
    FormatOutput("%s %s", "Hi", "there!");  //  9 chars + null
    FormatOutput("%s %s", "Hi", "there!!"); // 10 chars + null
}

nSize: 8, buff: Hi there
nSize: 9, buff: Hi there!
nSize: 10, buff: Hi there!

関連項目

ストリーム入出力
vprintf 関数
書式指定構文: printf 関数と wprintf 関数
fprintf、 _fprintf_l、 fwprintf、 _fwprintf_l
printf、 _printf_l、 wprintf、 _wprintf_l
sprintf、 _sprintf_l、 swprintf、 _swprintf_l、 __swprintf_l
va_arg、 va_copy、 va_end、 va_start