_fprintf_p、_fprintf_p_l、_fwprintf_p、_fwprintf_p_l

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

更新 : 2007 年 11 月

書式付きデータをストリームに出力します。

int _fprintf_p( 
   FILE *stream,
   const char *format [,
      argument ]...
);
int _fprintf_p_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
      argument ]...
);
int _fwprintf_p( 
   FILE *stream,
   const wchar_t *format [,
      argument ]...
);
int _fwprintf_p_l( 
   FILE *stream,
   const wchar_t *format,
   locale_t locale [,
      argument ]...
);

パラメータ

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

戻り値

_fprintf_p 関数と _fwprintf_p 関数は、書き込まれた文字数を返します。出力エラーが発生した場合は負の値を返します。

解説

_fprintf_p 関数は、一連の文字および値を書式化し、出力 stream に出力します。各関数の argument (指定されている場合) は、format 中の対応する書式指定に応じて変換され、格納されます。_fprintf_p の引数 format の構文および使用方法は、_printf_p と同じです。これらの関数は位置指定パラメータをサポートします。つまり、書式指定文字列で使用するパラメータの順序を変更できます。位置指定パラメータの詳細については、「printf_p の位置指定パラメータ」を参照してください。

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

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

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

セキュリティが万全ではないバージョンと同様 (「fprintf、_fprintf_l、fwprintf、_fwprintf_l」を参照)、これらの関数はパラメータを検証し、stream か format のいずれかが null ポインタの場合、または未知の書式指定子や不適切な形式の書式指定子がある場合は、「パラメータの検証」に説明されているように、無効なパラメータハンドラを呼び出します。実行の継続が許可された場合、関数は -1 を返し、errno を EINVAL に設定します。

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

Tchar.h のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_ftprintf_p	_fprintf_p	_fprintf_p	_fwprintf_p
_ftprintf_p_l	_fprintf_p_l	_fprintf_p_l	_fwprintf_p_l

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

必要条件

関数	必須ヘッダー
_fprintf_p, _fprintf_p_l	<stdio.h>
_fwprintf_p, _fwprintf_p_l	<stdio.h> または <wchar.h>

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

使用例

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

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


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

    // Open the file
    if ( fopen_s( &stream, "fprintf_p.out", "w" ) == 0)
    {
        // Format and print data
        _fprintf_p( stream, "%2$s%1$c", c, s );
        _fprintf_p( stream, "%d\n", i );
        _fprintf_p( stream, "%f\n", fp );

        // Close the file
        fclose( stream );
    }

    // Verify our data
    system( "type fprintf_p.out" );
}

this is a string
10
1.500000