vsnprintf_s、 _vsnprintf_s、 _vsnprintf_s_l、 _vsnwprintf_s、 _vsnwprintf_s_l

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

構文

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
出力を書式設定するときに使用するロケール。

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

戻り値

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

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

注釈

これらの各関数は、引数リストへのポインタを受け取り、指定されたデータの最大 count 文字を書式設定して、 buffer が指すメモリに書き込み、終了 NULL を追加します。

デバッグ ビルドでは、_CrtSetDebugFillThreshold で説明されているように、終了 NULL の後の残りの sizeOfBuffer バイトに xFE が入力されます。

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

vsnprintf_s は _vsnprintf_s と同じで、ANSI 規格に準拠するために含まれています。 _vnsprintf は、下位互換性のために保持されます。

動作の概要

次の表について、次のようにします。

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

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

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

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

要求事項

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

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

例

// 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