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文字を指します。
• 無効なパラメーター ハンドラーの詳細については、「 パラメーターの検証を参照してください。

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

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

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

要件

* 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