vsprintf_s、_vsprintf_s_l、vswprintf_s、_vswprintf_s_l

[アーティクル]
08/09/2011

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

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 ポインターの場合、カウントが 0 の場合、または書式指定文字列に無効な書式指定文字が含まれている場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、関数は -1 を返し、errno を EINVAL に設定します。

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

解説

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

vswprintf_sISO C 標準に準拠しているvswprintf、2 番目のパラメーターでは、必要なcount、タイプのsize_t。

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

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

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

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

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 との互換性用

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// 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 <stdarg.h>

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

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

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