vprintf_s、_vprintf_s_l、vwprintf_s、_vwprintf_s_l

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

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

int vprintf_s(
   const char *format,
   va_list argptr 
);
int _vprintf_s_l(
   const char *format,
   locale_t locale,
   va_list argptr 
);
int vwprintf_s(
   const wchar_t *format,
   va_list argptr 
);
int _vwprintf_s_l(
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);

パラメータ

format
書式の指定。
argptr
引数リストへのポインタ。
locale
使用するロケール。

戻り値

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

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

解説

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

これらの関数のセキュリティが強化されたバージョンは、書式指定文字列に有効な書式指定文字が含まれていることを確認する点を除いて、vprintf 関数および vwprintf 関数と同じです。

vwprintf_s は vprintf_s のワイド文字バージョンであり、ストリームが ANSI モードで開いている場合、この 2 つの関数の動作は同じです。現在 vprintf_s では、UNICODE ストリームへの出力はサポートされていません。

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

セキュリティに関するメモ :
format にユーザー定義の文字列を指定しないでください。詳細については、「Avoiding Buffer Overruns」を参照してください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_vtprintf_s	vprintf_s	vprintf_s	vwprintf_s
_vtprintf_s_l	_vprintf_s_l	_vprintf_s_l	_vwprintf_s_l

必要条件

ルーチン	必須ヘッダー	省略可能なヘッダー
vprintf_s, _vprintf_s_l	<stdio.h> および <stdarg.h>	<varargs.h>*
vwprintf_s, _vwprintf_s_l	<stdio.h> または <wchar.h>、および <stdarg.h>	<varargs.h>*