vfprintf、_vfprintf_l、vfwprintf、_vfwprintf_l

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

更新 : 2007 年 11 月

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

int vfprintf(
   FILE *stream,
   const char *format,
   va_list argptr 
);
int _vfprintf_l(
   FILE *stream,
   const char *format,
   locale_t locale,
      va_list argptr 
);
int vfwprintf(
      FILE *stream,
   const wchar_t *format,
      va_list argptr 
);
int _vfwprintf_l(
      FILE *stream,
   const wchar_t *format,
   locale_t locale,
   va_list argptr 
);

パラメータ

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

詳細については、「printf 関数と wprintf 関数の書式指定フィールド」を参照してください。

戻り値

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

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

解説

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

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

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

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_vftprintf	vfprintf	vfprintf	vfwprintf
_vftprintf_l	_vfprintf_l	_vfprintf_l	_vfwprintf_l

必要条件

ルーチン	必須ヘッダー	省略可能なヘッダー
vfprintf, _vfprintf_l	<stdio.h> および <stdarg.h>	<varargs.h>*
vfwprintf, _vfwprintf_l	<stdio.h> または <wchar.h>、および <stdarg.h>	<varargs.h>*