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 つの文字が含まれます。

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

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

動作の概要

次の表の場合:

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

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

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

要件

_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