vsprintf、_vsprintf_l、vswprintf、_vswprintf_l、__vswprintf_l

[アーティクル]
02/21/2013

引数リストへのポインターを使用して、書式付き出力を書き込みます。これらの関数のセキュリティを強化したバージョンについては、「vsprintf_s、_vsprintf_s_l、vswprintf_s、_vswprintf_s_l」を参照してください。

int vsprintf(
   char *buffer,
   const char *format,
   va_list argptr 
); 
int _vsprintf_l(
   char *buffer,
   const char *format,
   locale_t locale,
   va_list argptr 
); 
int vswprintf(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   va_list argptr 
);
int _vswprintf_l(
   wchar_t *buffer,
   size_t count,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
int __vswprintf_l(
   wchar_t *buffer,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);
template <size_t size>
int vsprintf(
   char (&buffer)[size],
   const char *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vsprintf_l(
   char (&buffer)[size],
   const char *format,
   locale_t locale,
   va_list argptr 
); // C++ only
template <size_t size>
int vswprintf(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   va_list argptr 
); // C++ only
template <size_t size>
int _vswprintf_l(
   wchar_t (&buffer)[size],
   size_t count,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
); // C++ only

パラメーター

buffer
出力の格納位置。
count
この関数の UNICODE のバージョンに格納する最大文字数。
format
書式の指定。
argptr
引数リストへのポインター。
locale
使用するロケール。

戻り値

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

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

解説

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

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

セキュリティに関するメモ
vsprintf を使用して書き込まれた文字数を制限する方法はここではありませんがこの関数を使用してコードがバッファーオーバーランに依存することを意味します。_vsnprintf を使用するか必要なバッファーの方法を確認するに _vscprintf を呼び出します。また、format にユーザー定義の文字列を指定しないでください。詳細については、「Avoiding Buffer Overruns」を参照してください。

vsprintf を使用して書き込まれた文字数を制限する方法はここではありませんがこの関数を使用してコードがバッファーオーバーランに依存することを意味します。_vsnprintf を使用するか必要なバッファーの方法を確認するに _vscprintf を呼び出します。また、format にユーザー定義の文字列を指定しないでください。詳細については、「Avoiding Buffer Overruns」を参照してください。

vswprintf は2 番目のパラメーターが 15 の ISO C 規格型 size_t の count準拠します。古い非標準の動作を強制的に実行するには以前の動作が将来のバージョンにあるコードは新しい標準動作を使用するように変更する必要があります _CRT_NON_CONFORMING_SWPRINTFS. を定義します。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_vstprintf	vsprintf	vsprintf	vswprintf
_vstprintf_l	_vsprintf_l	_vsprintf_l	_vswprintf_l

必要条件

ルーチン	必須ヘッダー	省略可能なヘッダー
vsprintf, _vsprintf_l	<stdio.h> および <stdarg.h>	<varargs.h>*
vswprintf, _vswprintf_l	<stdio.h> または <wchar.h>、および <stdarg.h>	<varargs.h>*

* UNIX V との互換性用

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

使用例

// crt_vsprintf.c
// compile with: /W3
// This program uses vsprintf 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 * format, ... )
{
    va_list args;
    int     len;
    char    *buffer;

    // retrieve the variable arguments
    va_start( args, format );
    
    len = _vscprintf( format, args ) // _vscprintf doesn't count
                                + 1; // terminating '\0'
    
    buffer = (char*)malloc( len * sizeof(char) );

    vsprintf( buffer, format, args ); // C4996
    // Note: vsprintf is deprecated; consider using vsprintf_s instead
    puts( buffer );

    free( buffer );
}

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

同等の .NET Framework 関数

System::String::Format

vsprintf、_vsprintf_l、vswprintf、_vswprintf_l、__vswprintf_l

パラメーター

戻り値

解説

必要条件

使用例

同等の .NET Framework 関数

参照

関連項目

その他のリソース