vsprintf_s、 _vsprintf_s_l、 vswprintf_s、 _vswprintf_s_l、 _vstprintf_s、 _vstprintf_s_l

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

_vstprintf_sと_vstprintf_s_lについては、Generic-text 関数のマッピングを参照してください。

構文

int vsprintf_s(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   va_list argptr
);
int _vsprintf_s_l(
   char *buffer,
   size_t numberOfElements,
   const char *format,
   _locale_t locale,
   va_list argptr
);
int vswprintf_s(
   wchar_t *buffer,
   size_t numberOfElements,
   const wchar_t *format,
   va_list argptr
);
int _vswprintf_s_l(
   wchar_t *buffer,
   size_t numberOfElements,
   const wchar_t *format,
   _locale_t locale,
   va_list argptr
);
template <size_t size>
int vsprintf_s(
   char (&buffer)[size],
   const char *format,
   va_list argptr
); // C++ only
template <size_t size>
int vswprintf_s(
   wchar_t (&buffer)[size],
   const wchar_t *format,
   va_list argptr
); // C++ only

パラメーター

buffer
出力の格納位置。

numberOfElements
文字内の buffer のサイズ。

format
書式の指定。

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

locale
使用するロケール。

戻り値

vsprintf_s 関数と vswprintf_s 関数は、書き込まれた文字数を返します。終端の null 文字は含まれません。出力エラーが発生した場合は、負の値を返します。 bufferまたはformatが null ポインターの場合、numberOfElementsがゼロの場合、または書式指定文字列に無効な書式設定文字が含まれている場合は、「Parameter 検証で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、関数は -1 を返し、errno を EINVAL に設定します。

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

解説

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

vswprintf_s 関数は vswprintf の ISO C 規格に準拠しています。この規格では、2 番目のパラメーター count を size_t 型で指定する必要があります。

これらの関数は、セキュリティ保護されたバージョンが位置指定パラメーターをサポートする点を除いて、セキュリティが万全でないバージョンと同じです。 詳細については、「printf_p の位置指定パラメーター」を参照してください。

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

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

重要

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' にリンクします。

汎用テキスト関数マッピング

tchar.h列の関数は、コンパイル時に定義されている文字セットに応じて、他の列の関数にマップされます。

tchar.h 関数	_UNICODE と _MBCS が定義されていない	_MBCS が定義されている	_UNICODE が定義されている
_vstprintf_s	vsprintf_s	vsprintf_s	vswprintf_s
_vstprintf_s_l	_vsprintf_s_l	_vsprintf_s_l	_vswprintf_s_l

要件

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

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

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

例

// crt_vsprintf_s.c
// Compile with: cl /W4 crt_vsprintf_s.c
// This program uses vsprintf_s to write to a buffer.
// The size of the buffer is determined by _vscprintf.

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>

void test( char const * const format, ... )
{
   va_list args;
   int len;
   char * buffer;

   va_start( args, format );
   len = _vscprintf( format, args ) // _vscprintf doesn't count
                               + 1; // terminating '\0'
   buffer = (char *) malloc( len * sizeof(char) );
   if ( NULL != buffer )
   {
      vsprintf_s( buffer, len, format, args );
      puts( buffer );
      free( buffer );
   }
   va_end( args );
}

int main( void )
{
   test( "%d %c %d", 123, '<', 456 );
   test( "%s", "This is a string" );
}

123 < 456
This is a string

関連項目

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