vsnprintf_s、 _vsnprintf_s、 _vsnprintf_s_l、 _vsnwprintf_s、 _vsnwprintf_s_l

引数リストへのポインターを使用して、書式付き出力を書き込みます。 これらの関数は、「CRT のセキュリティ機能で説明されているように、セキュリティが強化されたvsnprintf、_vsnprintf、_vsnprintf_l、_vsnwprintf、_vsnwprintf_lのバージョンです。

構文

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

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

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

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

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

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

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

パラメーター

buffer
出力の格納位置。

sizeOfBuffer
出力の buffer のサイズ。 charを受け取る関数のサイズはバイト単位、wchar_tを使用する関数の場合はワード。

count
書き込む最大文字数 (終端の NULLを含まない)。 wchar_tを受け取る関数の場合、書き込むワイド文字の数です。 または、_TRUNCATE です。

format
書式の指定。

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

locale
出力の書式設定時に使用するロケール。

詳細については、「 Format の仕様」を参照してください。

戻り値

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

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

解説

vsnprintf_s は _vsnprintf_s と同じであり、ANSI 標準に準拠するために含まれています。 _vnsprintf 関数は下位互換性のために残されています。

これらの関数は、引数リストへのポインターを使用し、指定されたデータを書式指定して count の文字数まで buffer が指すメモリに書き込み、終端の null を追加します。

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

動作の概要

次の表の場合:

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

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

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

重要

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

終端の null 用の空きを確保するために、count を必ずバッファー長未満にするか、_TRUNCATE を使用します。

C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファー長を自動的に推論できる (サイズの引数を指定する必要がなくなる) だけでなく、古くてセキュリティが万全ではない関数を新しく安全な関数に自動的に置き換えることができます。 詳細については、「セキュリティ保護されたテンプレート オーバーロード」を参照してください。

ヒント

未定義の外部 _vsnprintf_s エラーが発生し、ユニバーサル C ランタイムを使用している場合は、リンクするライブラリのセットに legacy_stdio_definitions.lib を追加します。 ユニバーサル C ランタイムは、この関数を直接エクスポートせず、代わりに <stdio.h>でインラインで定義されます。 詳細については、「 アップグレードの潜在的な問題の概要 Visual Studio 2015 準拠の変更を参照してください。

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

TCHAR.H ルーチン	_UNICODE と _MBCS が定義されていない	_MBCS が定義されている	_UNICODE が定義されている
_vsntprintf_s	_vsnprintf_s	_vsnprintf_s	_vsnwprintf_s
_vsntprintf_s_l	_vsnprintf_s_l	_vsnprintf_s_l	_vsnwprintf_s_l

要件

ルーチンによって返される値	必須ヘッダー	省略可能なヘッダー
vsnprintf_s	<stdio.h> および <stdarg.h>	<varargs.h>*
_vsnprintf_s, _vsnprintf_s_l	<stdio.h> および <stdarg.h>	<varargs.h>*
_vsnwprintf_s, _vsnwprintf_s_l	<stdio.h> または <wchar.h>、および <stdarg.h>	<varargs.h>*

* UNIX V の互換性のために必要です。

互換性の詳細については、「 Compatibility」を参照してください。

例

// crt_vsnprintf_s.cpp
#include <stdio.h>
#include <wtypes.h>

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

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

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

関連項目

ストリーム入出力
vprintf 関数
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