setvbuf

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

ストリームのバッファリングとバッファーサイズを制御します。

int setvbuf(
   FILE *stream,
   char *buffer,
   int mode,
   size_t size 
);

パラメーター

stream
FILE 構造体へのポインター。
buffer
ユーザーが割り当てたバッファー。
mode
バッファリングのモード。
size
バッファーサイズ (バイト単位)。許容範囲:2 < =size< INT_MAX (2147483647) を =。この値は、内部的には 2 の倍数に切り捨てられます。

戻り値

処理が正常に終了した場合は 0 を返します。

stream が NULL の場合、または mode か size が有効な範囲内にない場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、この関数は -1 を返し、errno を EINVAL に設定します。

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

解説

setvbuf 関数を使用すると、プログラムで stream のバッファリングとバッファーサイズを制御できます。 stream は、まだ読み取りも書き込みも行われていない開いているファイルを指している必要があります。 buffer が指す配列は、NULL でない限り、バッファーとして使用されます。NULL の場合、setvbuf は自動的に割り当てられる長さ size/2 * 2 バイトのバッファーを使用します。

mode は、_IOFBF、_IOLBF、または _IONBF のいずれかにします。 mode が _IOFBF または _IOLBF の場合、バッファーのサイズとして size が使用されます。 mode が _IONBF の場合、ストリームのバッファリングは行われないため、size と buffer は無視されます。 mode の値およびその意味は、次のとおりです。

_IOFBF
フルバッファリング。つまり buffer がバッファーとして、size がバッファーサイズとして使用されます。 buffer が NULL の場合は、自動的に割り当てられた size バイトのバッファーが使用されます。
_IOLBF
一部のシステムでは、行バッファリングを使用できます。ただし、Win32 の場合、動作は _IOFBF (フルバッファリング) と同じです。
_IONBF
buffer と size に関係なく、バッファーは使用されません。

必要条件

ルーチン	必須ヘッダー
setvbuf	<stdio.h>

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

ライブラリ

C ランタイムライブラリのすべてのバージョン。

使用例

// crt_setvbuf.c
// This program opens two streams: stream1
// and stream2. It then uses setvbuf to give stream1 a
// user-defined buffer of 1024 bytes and stream2 no buffer.
//

#include <stdio.h>

int main( void )
{
   char buf[1024];
   FILE *stream1, *stream2;

   if( fopen_s( &stream1, "data1", "a" ) == 0 &&
       fopen_s( &stream2, "data2", "w" ) == 0 )
   {
      if( setvbuf( stream1, buf, _IOFBF, sizeof( buf ) ) != 0 )
         printf( "Incorrect type or size of buffer for stream1\n" );
      else
         printf( "'stream1' now has a buffer of 1024 bytes\n" );
      if( setvbuf( stream2, NULL, _IONBF, 0 ) != 0 )
         printf( "Incorrect type or size of buffer for stream2\n" );
      else
         printf( "'stream2' now has no buffer\n" );
      _fcloseall();
   }
}