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 であるバージョンは、現在のスレッド ロケールの代わりに渡された locale パラメーターを使用する点を除いて同じです。

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

動作の概要

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

• sizeOfBufferをbufferのサイズとします。 関数が 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 固有です。 互換性の詳細については、「 互換性」を参照してください。

例: ワイド文字を _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