std::setvbuf

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

入出力ライブラリ

I/Oマニピュレータ

出力関数 (C++23)

C形式I/O

バッファ

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

ストリーム

抽象化

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

ファイルI/O

basic_ifstream

basic_ofstream

basic_fstream

文字列I/O

basic_istringstream

basic_ostringstream

basic_stringstream

配列I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同期出力

basic_osyncstream (C++20)

型

streamoff

streamsize

fpos

エラーカテゴリインターフェース

iostream_category (C++11)

io_errc (C++11)

 

C形式I/O

型とオブジェクト
FILE fpos_t	stdinstdoutstderr
関数
ファイルアクセス fopen freopen fclose fflush fwide setbuf setvbuf 直接入出力 fread fwrite 非書式化入出力 fgetcgetc fgets fputcputc fputs getchar gets (C++14まで) putchar puts ungetc fgetwcgetwc fgetws fputwcputwc fputws getwchar putwchar ungetwc 書式付き入力 scanffscanfsscanf vscanfvfscanfvsscanf (C++11)(C++11)(C++11)     wscanffwscanfswscanf vwscanfvfwscanfvswscanf (C++11)(C++11)(C++11)	書式付き出力 printffprintfsprintfsnprintf (C++11) vprintfvfprintfvsprintfvsnprintf (C++11)     wprintffwprintfswprintf vwprintfvfwprintfvswprintf ファイルポジショニング ftell fgetpos fseek fsetpos rewind エラーハンドリング clearerr feof ferror perror ファイル操作 remove rename tmpfile tmpnam

 

ヘッダ<cstdio>で定義
int setvbuf( std::FILE* stream, char* buffer, int mode, std::size_t size );

指定されたファイルストリームstreamのバッファリングモードを、引数modeで指定されたように変更します。さらに、

• もしbufferがヌルポインタの場合、内部バッファをsizeにリサイズします。
• もしbufferがヌルポインタでない場合、ストリームにsizeのサイズでbufferから始まるユーザー提供のバッファを使用するように指示します。lifetimeがbufferが指す配列のlifetimeよりも前に終了する前に、ストリームは（std::fcloseで）閉じられる必要があります。成功したstd::setvbufの呼び出し後の配列の内容は不定であり、それを使用する試みは未定義の動作です。

Parameters

stream	-	バッファを設定するファイルストリーム
buffer	-	ストリームが使用するバッファへのポインタ、またはサイズとモードのみを変更するためのヌルポインタ
モード	-	使用するバッファリングモード。以下のいずれかの値になります。 _IOFBF フルバッファリング _IOLBF ラインバッファリング _IONBF バッファリングなし
size	-	バッファのサイズ

Return value

成功した場合は​0​、失敗した場合はゼロ以外の値を返します。

Notes

この関数は、streamがオープンファイルに関連付けられた後、しかし他の操作（std::setbuf/std::setvbufの失敗した呼び出しを除く）の前にのみ使用できます。

sizeバイトすべてがバッファリングに使用されるとは限りません。実際のバッファサイズは、通常2の倍数、ページサイズの倍数などに切り捨てられます。

多くの実装では、ラインバッファリングは端末入力ストリームでのみ利用可能です。

一般的なエラーは、stdinまたはstdoutのバッファを、プログラム終了前にlifetimeが終了する配列に設定することです。

int main()
{
    char buf[BUFSIZ];
    std::setbuf(stdin, buf);
} // lifetime of buf ends, undefined behavior

デフォルトのバッファサイズBUFSIZは、実装においてファイルI/Oに最も効率的なバッファサイズであると期待されていますが、POSIXのfstatはより良い推定値を提供することがよくあります。

Example

バッファサイズを変更するユースケースの1つは、より良いサイズがわかっている場合です。

このコードを実行

#include <cstdio>
#include <cstdlib>
#include <iostream>
#include <sys/stat.h>
 
int main()
{
    std::FILE* fp = std::fopen("/tmp/test.txt", "w+");
    if (!fp)
    {
        std::perror("fopen");
        return EXIT_FAILURE;
    }
 
    struct stat stats;
    if (fstat(fileno(fp), &stats) == -1) // POSIX only
    {
        std::perror("fstat");
        return EXIT_FAILURE;
    }
 
    std::cout << "BUFSIZ is " << BUFSIZ << ", but optimal block size is "
              << stats.st_blksize << '\n';
    if (std::setvbuf(fp, nullptr, _IOFBF, stats.st_blksize) != 0)
    {
        std::perror("setvbuf failed"); // POSIX version sets errno
        return EXIT_FAILURE;
    }
 
    // Read entire file: use truss/strace to observe the read(2) syscalls used
    for (int ch; (ch = std::fgetc(fp)) != EOF;)
    {}
 
    std::fclose(fp);
    return EXIT_SUCCESS;
}

実行結果の例

BUFSIZ is 8192, but optimal block size is 65536

See also

setbuf	ファイルストリームのバッファを設定する (関数)
setbuf [virtual]	ユーザー提供のバッファを提供する、またはこのファイルバッファをバッファリングなしにする (std::basic_filebuf<CharT,Traits>の仮想protectedメンバ関数)
Cドキュメント （setvbuf）