Imported tab->space correction by redhat
[infodrom/manpages-de] / man3 / setbuf.3
1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the American National Standards Committee X3, on Information
6 .\" Processing Systems.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\"    must display the following acknowledgement:
18 .\"     This product includes software developed by the University of
19 .\"     California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\"    may be used to endorse or promote products derived from this software
22 .\"    without specific prior written permission.
23 .\"
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" SUCH DAMAGE.
35 .\"
36 .\"     @(#)setbuf.3    6.10 (Berkeley) 6/29/91
37 .\"
38 .\" Converted for Linux, Mon Nov 29 14:55:24 1993, faith@cs.unc.edu
39 .\" Added section to BUGS, Sun Mar 12 22:28:33 MET 1995,
40 .\"                   Thomas.Koenig@ciw.uni-karlsruhe.de
41 .\" Translated into german by Roland Krause <Rokrause@aol.com>
42 .\" Fri Jan 12 18:01:33 2001: Modified by Martin Schulze <joey@infodrom.north.de>
43 .\"
44 .TH SETBUF 3 "26. Januar 1997" "BSD MANPAGE" "Bibliotheksfunktionen"
45 .SH BEZEICHNUNG
46 setbuf, setvbuf \- Stream-Puffer Funktionen
47 .SH "ÜBERSICHT"
48 .na
49 .B #include <stdio.h>
50 .sp
51 .BI "int setbuf( FILE *" stream ", char *" buf );
52 .br
53 .BI "void setbuffer(FILE *" stream ", char *" buf ", size_t"  size );
54 .br
55 .BI "void setlinebuf(FILE *" stream );
56 .br
57 .BI "int setvbuf( FILE *" stream ", char *" buf ", int " mode
58 .BI ", size_t " size );
59 .ad
60 .SH BESCHREIBUNG
61
62 Die drei Typen der verfügbaren Pufferungen sind nicht-gepuffert,
63 block-gepuffert und zeilen-gepuffert.  Wenn ein Ausgabe-Stream
64 ungepuffert ist, erscheinen die Informationen in der Zieldatei oder
65 auf dem Terminal direkt nachdem sie geschrieben wurden.  Wenn die
66 Ausgabe block-gepuffert ist, werden viele Zeichen erst einmal
67 gesammelt und dann in einem Rutsch ausgegeben.  Wenn die Ausgabe
68 zeilen-gepuffert ist, werden die Zeichen bis zu einem Newline-Zeichen
69 gesammelt und erst dann ausgegeben, oder Eingaben wurden von einem
70 beliebigen Datenstrom gelesen, der mit dem Eingabegerät verbunden ist
71 (üblicherweise stdin).  Die Funktion
72 .BR fflush (3)
73 darf dazu verwendet werden, ein Leeren des Puffers zu erzwingen.
74 (Siehe auch
75 .BR fclose (3))
76 Normalerweise sind alle Dateien block-gepuffert.  Wenn die erste
77 I/O-Operation auf einer Datei durchgeführt wird, wird
78 .BR malloc (3)
79 aufgerufen und ein Puffer wird angelegt.  Wenn ein Datenstrom mit
80 einem Terminal verbunden ist (wie stdout normalerweise), ist er
81 zeilen-gepuffert.  Der normale Fehlerstrom (stderr) ist per default
82 immer nicht-gepuffert.
83
84 Die Funktion
85 .B setvbuf
86 wird genutzt, um zu jedem beliebigen Zeitpunkt die Pufferung eines
87 geöffneten Streams zu ändern.
88 Als
89 .I mode
90 - Parameter wird einer der drei folgenden Konstanten verwendet:
91 .RS
92 .TP
93 .B _IONBF
94 Nicht gepuffert
95 .TP
96 .B _IOLBF
97 Zeilenpufferung
98 .TP
99 .B _IOFBF
100 Blockpufferung
101 .RE
102 .PP
103 Mit Ausnahme von ungepufferten Dateien sollte mit
104 .I buf
105 ein Zeiger auf einen Puffer angegeben werden, der mindestens
106 .I size
107 Byte groß ist. Dieser Puffer wird anstelle des momentanen Puffers verwendet.
108 Wenn für
109 .I buf
110 .BR NULL ,
111 angegeben wird, wird nur
112 .I mode 
113 modifiziert. Bei der naechsten Schreib- oder Leseoperation wird ein neuer
114 Puffer allokiert.
115 Die Funktion
116 .I setvbuf
117 kann nur dann auf einen geöffneten Stream angewendet werden, wenn er nicht
118 ``aktiv'' ist. Das heißt, vor der ersten Ein- bzw. Ausgabe oder unmittelbar
119 nach einem
120 .BR fflush .
121
122 Die anderen drei Funktionen sind im Endeffekt einfache Aliase für
123 Aufrufe von
124 .BR setvbuf .
125 Die Funktion
126 .B setbuf
127 entspricht genau dem folgendem Aufruf:
128 .PP
129   setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);
130
131 Die Funktion
132 .B setbuffer
133 ist die gleiche, bis auf die Tatsache, dass die Größe des Puffers vom
134 Aufrufer bestimmt wird anstatt von der Voreinstellung
135 .B BUFSIZ
136 übernommen wird.  Die Funktion
137 .B setlinebuf
138 entspricht genau dem folgendem Aufruf:
139 .PP
140   setvbuf(stream, (char *)NULL, _IOLBF, 0);
141
142 .SH KONFORM ZU
143 Die Funktionen
144 .B setbuf
145 und
146 .B setvbuf
147 sind konform zu ANSI C3.159-1989 (ANSI C).
148 .SH Fehler
149 Die Funktionen
150 .B setbuffer
151 und
152 .B setlinebuf
153 sind keine portablen Versionen von BSD vor 4.2BSD,
154 .B setbuf
155 nutzt immer eine nichtoptimale Puffergröße und sollte deshalb
156 vermieden werden.
157
158 Es muss sichergestellt sein, dass der Puffer
159 .I buf
160 zu dem Zeitpunkt, zu dem der Stream
161 .I stream
162 geschlossen wird, noch existiert, was ebenfalls bei Programmende geschieht.
163 .P
164 Im folgenden Beispiel wird der Stream
165 .I stdin
166 erst geschlossen wenn
167 .I buf
168 nicht mehr existiert.  Dieser Code ist nicht zulässig:
169 .nf
170 .sp
171 #include <stdio.h>
172 int main()
173 {
174     char buf[BUFSIZ];
175     setbuf(stdin, buf);
176     printf("Hello, world!\\n");
177     return 0;
178 }
179 .fi
180 .sp
181 .SH "SIEHE AUCH"
182 .BR fopen (3),
183 .BR fflush (3),
184 .BR fclose (3),
185 .BR fread (3),
186 .BR malloc (3),
187 .BR puts (3),
188 .BR printf (3).