draft/man3/fmemopen.3

   1 .\" Copyright 2005 walter harms (walter.harms@informatik.uni-oldenburg.de),
   2 .\" and Copyright 2005 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\" Distributed under the GPL.
   4 .\" 2008-12-04, Petr Baudis <pasky@suse.cz>: Document open_wmemstream()
   5 .\"
   6 .\"*******************************************************************
   7 .\"
   8 .\" This file was generated with po4a. Translate the source file.
   9 .\"
  10 .\"*******************************************************************
  11 .TH FMEMOPEN 3 2010\-09\-15 GNU "Linux Programmer's Manual"
  12 .SH 名前
  13 fmemopen, open_memstream, open_wmemstream \- メモリをストリームとしてオープンする
  14 .SH 書式
  15 .nf
  16 \fB#include <stdio.h>\fP
  17
  18 \fBFILE *fmemopen(void *\fP\fIbuf\fP\fB, size_t \fP\fIsize\fP\fB, const char *\fP\fImode\fP\fB);\fP
  19
  20 \fBFILE *open_memstream(char **\fP\fIptr\fP\fB, size_t *\fP\fIsizeloc\fP\fB);\fP
  21
  22 \fB#include <wchar.h>\fP
  23
  24 \fBFILE *open_wmemstream(wchar_t **\fP\fIptr\fP\fB, size_t *\fP\fIsizeloc\fP\fB);\fP
  25 .fi
  26 .sp
  27 .in -4n
  28 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  29 .in
  30 .sp
  31 \fBfmemopen\fP(), \fBopen_memstream\fP(), \fBopen_wmemstream\fP():
  32 .PD 0
  33 .ad l
  34 .RS 4
  35 .TP  4
  36 glibc 2.10 以降:
  37 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  38 .TP
  39 glibc 2.10 より前:
  40 _GNU_SOURCE
  41 .RE
  42 .ad
  43 .PD
  44 .SH 説明
  45 \fBfmemopen\fP()  関数は、ストリームをオープンし、そのストリームに \fImode\fP で指定されたアクセス許可を設定する。
  46 そのストリームを通じて、 \fIbuf\fP で指定された文字列やメモリバッファへの読み書きができる。 このバッファは少なくとも \fIsize\fP
  47 バイトの長さでなければならない。
  48 .PP
  49 引き数 \fImode\fP は \fBfopen\fP(3)  の場合と同じである。 \fImode\fP で追記モード (append mode)
  50 が指定された場合、ファイル位置の初期値は バッファ中の最初の NULL バイト (\(aq\e0\(aq) の位置に設定される。
  51 それ以外の場合は、ファイル位置の初期値はバッファの先頭になる。 glibc 2.9 以降では、文字 'b' を \fImode\fP
  52 の二番目の文字として指定することができる。 この文字は「バイナリ」モードを指定するものである。
  53 このモードでは、書き込み時に文字列終端のヌルバイトが黙って追加 されることはない。また、 \fBfseek\fP(3)  \fBSEEK_END\fP
  54 は、文字列の長さからの相対値ではなく、バッファの末尾 (\fIsize\fP で指定した値) からの相対値となる。
  55 .PP
  56 書き込み用にオープンされたストリームをフラッシュ (\fBfflush\fP(3))  やクローズ (\fBfclose\fP(3))  した時に、
  57 (バッファに空きがあれば) NULL バイトがバッファの末尾に書き込まれる。 このようにするためには、呼び出し元は バッファに 1バイト余裕を作る
  58 (\fIsize\fP にこの 1バイトを含めた値を指定する) 必要がある。
  59
  60 .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=1995
  61 .\" and
  62 .\" http://sources.redhat.com/ml/libc-alpha/2006-04/msg00064.html
  63 バッファに \fIsize\fP バイトよりたくさん書き込もうとした場合には、エラーとなる。 (デフォルトでは、このようなエラーが見えるのは \fIstdio\fP
  64 バッファがフラッシュされた時だけである。 \fIsetbuf(fp,\ NULL)\fP を使ってバッファリングを無効にする方法は、
  65 出力操作を行った時点でエラーを検出するのに役立つ。 別の方法としては、 \fIsetbuffer(fp, buf, size)\fP
  66 を使って、呼び出し側が明示的に stdio ストリームバッファとして \fIbuf\fP を指定し、バッファの指定時にバッファのサイズを stdio
  67 に教える方法がある。)
  68 .PP
  69 読み出し用にオープンされたストリームでは、 バッファ内に NULL バイト (\(aq\e0\(aq) があっても 読み出し操作がファイル末尾
  70 (end\-of\-file) を返すことはない。 バッファからの読み出しでファイル末尾が返るのは、 ファイルポインタがバッファの先頭から \fIsize\fP
  71 バイトを越えて先に進もうとした場合だけである。
  72 .PP
  73 \fIbuf\fP に NULL が指定された場合、 \fBfmemopen\fP()  は動的に \fIsize\fP バイトの長さのバッファを確保する。
  74 この方法は、一時バッファにデータの書き込みを行ってから、 その内容を再度読み出すようなアプリケーションで有用である。
  75 このバッファはストリームがクローズされるときに自動的に解放される。 呼び出し元からはこの関数が割り当てた一時バッファへのポインタ値を
  76 知る方法は存在しない点に注意 (下記の \fBopen_memstream\fP()  も参照)。
  77
  78 \fBopen_memstream\fP()  関数は、バッファへの書き込み用にストリームをオープンする。 バッファは (\fBmalloc\fP(3)
  79 を使って) 動的に割り当てられ、必要に応じて自動的に伸長する。 ストリームをクローズした後で、呼び出し元はこのバッファを \fBfree\fP(3)
  80 すべきである。
  81
  82 このストリームが クローズ (\fBfclose\fP(3))  されたりフラッシュ (\fBfflush\fP(3))  された時に、 \fIptr\fP と
  83 \fIsizeloc\fP の値はそれぞれバッファへのポインタとそのサイズに更新される。 これらの値は、呼び出し元がそのストリームに新たな書き込みを
  84 行わない場合に限り有効である。 ストリームに書き込みを行った際には、これらの変数を参照する前に ストリームを再度フラッシュしなければならない。
  85
  86 バッファ末尾の NULL バイトは保持される。 この NULL バイトは \fIsizeloc\fP に格納されるサイズには「含まれない」。
  87
  88 ストリームのファイル位置は \fBfseek\fP(3)  や \fBfseeko\fP(3)  で変更できる。
  89 すでにデータが書き込まれた領域の末尾より先にファイル位置を動かすと、 その間の領域は 0 で埋められる。
  90
  91 \fBopen_wmemstream\fP()  は \fBopen_memstream\fP()
  92 と同様だが、バイトではなくワイド文字に対して操作を行う点が異なる。
  93 .SH 返り値
  94 成功して終了した場合には、 \fBfmemopen\fP(), \fBopen_memstream\fP(), \fBopen_wmemstream\fP()  は
  95 \fIFILE\fP ポインタを返す。 失敗した場合は、 NULL を返し、 \fIerrno\fP にエラーを示す値をセットする。
  96 .SH バージョン
  97 \fBfmemopen\fP()  と \fBopen_memstream\fP()  は glibc 1.0.x ですでに利用可能であった。
  98 \fBopen_wmemstream\fP()  は glibc 2.4 以降で利用可能である。
  99 .SH 準拠
 100 POSIX.1\-2008.  これらの関数は POSIX.1\-2001 では規定れていないが、 Linux 以外のシステムで広く利用可能である。
 101 .SH 注意
 102 これらの関数が返すファイルストリームに対応するファイル ディスクリプタはない (つまり、返されたストリームに対して \fBfileno\fP(3)
 103 を呼び出すとエラーが返ることになる)。
 104 .SH バグ
 105 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=1996
 106 バージョン 2.7 より前の glibc では、 \fBopen_memstream\fP()
 107 で作成されたストリームの末尾より先にファイル位置を動かしても、 バッファが伸長されず、 \fBfseek\fP(3)  が失敗し \-1 が返る。
 108 .SH 例
 109 このプログラムは \fBfmemopen\fP()  を使って出力バッファをオープンし、 \fBopen_memstream\fP()
 110 を使って動的にサイズが変化する出力バッファをオープンしている。 (プログラムの第一コマンドライン引き数から取った) 入力文字列を
 111 スキャンして整数を読み込み、これらの整数の二乗を出力バッファに書き出す。 このプログラムの実行例は以下のようになる。
 112 .in +4n
 113 .nf
 114
 115 $\fB ./a.out \(aq1 23 43\(aq\fP
 116 size=11; ptr=1 529 1849
 117 .fi
 118 .in
 119 .SS プログラムのソース
 120 \&
 121 .nf
 122 #define _GNU_SOURCE
 123 #include <string.h>
 124 #include <stdio.h>
 125 #include <stdlib.h>
 126
 127 #define handle_error(msg) \e
 128     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 129
 130 int
 131 main(int argc, char *argv[])
 132 {
 133     FILE *out, *in;
 134     int v, s;
 135     size_t size;
 136     char *ptr;
 137
 138     if (argc != 2) {
 139         fprintf(stderr, "Usage: %s <file>\en", argv[0]);
 140         exit(EXIT_FAILURE);
 141     }
 142
 143     in = fmemopen(argv[1], strlen(argv[1]), "r");
 144     if (in == NULL)
 145         handle_error("fmemopen");
 146
 147     out = open_memstream(&ptr, &size);
 148     if (out == NULL)
 149         handle_error("open_memstream");
 150
 151     for (;;) {
 152         s = fscanf(in, "%d", &v);
 153         if (s <= 0)
 154             break;
 155
 156         s = fprintf(out, "%d ", v * v);
 157         if (s == \-1)
 158             handle_error("fprintf");
 159     }
 160     fclose(in);
 161     fclose(out);
 162     printf("size=%ld; ptr=%s\en", (long) size, ptr);
 163     free(ptr);
 164     exit(EXIT_SUCCESS);
 165 }
 166 .fi
 167 .SH 関連項目
 168 \fBfopen\fP(3), \fBfopencookie\fP(3)
 169 .SH この文書について
 170 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.40 の一部
 171 である。プロジェクトの説明とバグ報告に関する情報は
 172 http://www.kernel.org/doc/man\-pages/ に書かれている。