fprintf_s、_fprintf_s_l、fwprintf_s、_fwprintf_s_l

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

書式付きデータをストリームに出力します。これらの関数は、「CRT のセキュリティ機能」に説明されているように、fprintf、_fprintf_l、fwprintf、_fwprintf_l のセキュリティが強化されたバージョンです。

int fprintf_s( 
   FILE *stream,
   const char *format [,
   argument ]...
);
int _fprintf_s_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
   argument ]...
);
int fwprintf_s( 
   FILE *stream,
   const wchar_t *format [,
   argument ]...
);
int _fwprintf_s_l( 
   FILE *stream,
   const wchar_t *format,
   locale_t locale [,
   argument ]…
);

パラメーター

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

戻り値

fprintf_s は、出力したバイト数を返します。 fwprintf_s は、出力したワイド文字数を返します。出力エラーが発生した場合、これらの関数は負の値を返します。

解説

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

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

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

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

セキュリティが万全ではないバージョンと同様 (「fprintf、_fprintf_l、fwprintf、_fwprintf_l」を参照)、これらの関数はパラメーターを検証し、stream または format が null ポインターの場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーを呼び出します。これらの関数は、書式指定文字列自体の検証も行う点で、セキュリティが万全ではないバージョンと異なります。未知の書式指定子や不適切な形式の書式指定子がある場合、これらの関数は無効なパラメーター例外を生成します。すべての場合において、実行の継続が許可された場合、関数は -1 を返し、errno を EINVAL に設定します。エラーコードの詳細については、「_doserrno、errno、_sys_errlist、および _sys_nerr」を参照してください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_ftprintf_s	fprintf_s	fprintf_s	fwprintf_s
_ftprintf_s_l	_fprintf_s_l	_fprintf_s_l	_fwprintf_s_l

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

必要条件

機能	必須ヘッダー
fprintf_s, _fprintf_s_l	<stdio.h>
fwprintf_s, _fwprintf_s_l	<stdio.h> または <wchar.h>

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

使用例

// crt_fprintf_s.c
// This program uses fprintf_s to format various
// data and print it to the file named FPRINTF_S.OUT. It
// then displays FPRINTF_S.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_s.out", "w" );
   fprintf_s( stream, "%s%c", s, c );
   fprintf_s( stream, "%d\n", i );
   fprintf_s( stream, "%f\n", fp );
   fclose( stream );
   system( "type fprintf_s.out" );
}