fprintf、_fprintf_l、fwprintf、_fwprintf_l

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

書式付きデータをストリームに出力します。これらの関数のセキュリティを強化したバージョンについては、「fprintf_s、_fprintf_s_l、fwprintf_s、_fwprintf_s_l」を参照してください。

int fprintf( 
   FILE *stream,
   const char *format [,
   argument ]...
);
int _fprintf_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
   argument ]...
);
int fwprintf( 
   FILE *stream,
   const wchar_t *format [,
   argument ]...
);
int _fwprintf_l( 
   FILE *stream,
   const wchar_t *format,
   locale_t locale [,
   argument ]...
);

パラメーター

stream
FILE 構造体へのポインター。
format
書式指定文字列。
argument
省略可能な引数。
locale
使用するロケール。

戻り値

fprintf は、出力したバイト数を返します。 fwprintf は、出力したワイド文字数を返します。出力エラーが発生した場合、これらの関数は負の値を返します。 stream または format が NULL の場合、「パラメーターの検証」に説明されているように、これらの関数は無効なパラメーターハンドラーを呼び出します。実行の継続が許可された場合、関数は -1 を返し、errno を EINVAL に設定します。書式指定文字列は、fprintf_s または fwprintf_s を使用する場合とは異なり、有効な書式指定文字のチェックが行われません。

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

解説

fprintf 関数は、一連の文字および値を書式化し、出力 stream に出力します。各関数の argument (指定されている場合) は、format 中の対応する書式指定に応じて変換され、格納されます。fprintf の引数 format の構文および使用方法は、printf と同じです。

fwprintf 関数は、fprintf 関数のワイド文字バージョンで、fwprintf 関数の format はワイド文字列です。ストリームが ANSI モードで開かれている場合、これらの関数の動作は同じになります。 fprintf では、UNICODE ストリームへの出力はサポートされていません。

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

セキュリティに関するメモ
format にユーザー定義の文字列を指定しないでください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_ftprintf	fprintf	fprintf	fwprintf
_ftprintf_l	_fprintf_l	_fprintf_l	_fwprintf_l

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

必要条件

機能	必須ヘッダー
fprintf, _fprintf_l	<stdio.h>
fwprintf, _fwprintf_l	<stdio.h> または <wchar.h>

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

使用例

// crt_fprintf.c
/* This program uses fprintf to format various
 * data and print it to the file named FPRINTF.OUT. It
 * then displays FPRINTF.OUT on the screen using the system
 * function to invoke the operating-system TYPE command.
 */

#include <stdio.h>
#include <process.h>

FILE *stream;

int main( void )
{
   int    i = 10;
   double fp = 1.5;
   char   s[] = "this is a string";
   char   c = '\n';

   fopen_s( &stream, "fprintf.out", "w" );
   fprintf( stream, "%s%c", s, c );
   fprintf( stream, "%d\n", i );
   fprintf( stream, "%f\n", fp );
   fclose( stream );
   system( "type fprintf.out" );
}