raw/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 .\" Correction,  Sun, 11 Apr 1999 15:55:18,
  42 .\"     Martin Vicente <martin@netadmin.dgac.fr>
  43 .\" Correction,  2000-03-03, Andreas Jaeger <aj@suse.de>
  44 .\" Added return value for setvbuf, aeb,
  45 .\"
  46 .TH SETBUF 3  2001-06-09 "Linux" "Linux Programmer's Manual"
  47 .SH NAME
  48 setbuf, setbuffer, setlinebuf, setvbuf \- stream buffering operations
  49 .SH SYNOPSIS
  50 .na
  51 .B #include <stdio.h>
  52 .sp
  53 .BI "void setbuf(FILE *" stream ", char *" buf );
  54 .br
  55 .BI "void setbuffer(FILE *" stream ", char *" buf ", size_t "  size );
  56 .br
  57 .BI "void setlinebuf(FILE *" stream );
  58 .br
  59 .BI "int setvbuf(FILE *" stream ", char *" buf ", int " mode
  60 .BI ", size_t " size );
  61 .ad
  62 .SH DESCRIPTION
  63 The three types of buffering available are unbuffered, block buffered, and
  64 line buffered.  When an output stream is unbuffered, information appears on
  65 the destination file or terminal as soon as written; when it is block
  66 buffered many characters are saved up and written as a block; when it is
  67 line buffered characters are saved up until a newline is output or input is
  68 read from any stream attached to a terminal device (typically stdin).  The
  69 function
  70 .BR fflush (3)
  71 may be used to force the block out early.
  72 (See
  73 .BR fclose (3).)
  74 Normally all files are block buffered.  When the first I/O operation occurs
  75 on a file,
  76 .BR malloc (3)
  77 is called, and a buffer is obtained.  If a stream refers to a terminal (as
  78 .I stdout
  79 normally does) it is line buffered.  The standard error stream
  80 .I stderr
  81 is always unbuffered by default.
  82 .PP
  83 The
  84 .B setvbuf
  85 function may be used on any open stream to change its buffer.
  86 The
  87 .I mode
  88 parameter must be one of the following three macros:
  89 .RS
  90 .TP
  91 .B _IONBF
  92 unbuffered
  93 .TP
  94 .B _IOLBF
  95 line buffered
  96 .TP
  97 .B _IOFBF
  98 fully buffered
  99 .RE
 100 .PP
 101 Except for unbuffered files, the
 102 .I buf
 103 argument should point to a buffer at least
 104 .I size
 105 bytes long; this buffer will be used instead of the current buffer.  If the
 106 argument
 107 .I buf
 108 is
 109 .BR NULL ,
 110 only the mode is affected; a new buffer will be allocated on the next read
 111 or write operation.  The
 112 .B setvbuf
 113 function may only be used after opening a stream and before any other
 114 operations have been performed on it.
 115 .PP
 116 The other three calls are, in effect, simply aliases for calls to
 117 .BR setvbuf .
 118 The
 119 .B setbuf
 120 function is exactly equivalent to the call
 121 .PP
 122 .RS
 123 setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);
 124 .RE
 125 .PP
 126 The
 127 .B setbuffer
 128 function is the same, except that the size of the buffer is up to the
 129 caller, rather than being determined by the default
 130 .BR BUFSIZ .
 131 The
 132 .B setlinebuf
 133 function is exactly equivalent to the call:
 134 .PP
 135 .RS
 136 setvbuf(stream, (char *)NULL, _IOLBF, 0);
 137 .RE
 138 .SH "RETURN VALUE"
 139 The function
 140 .B setvbuf
 141 returns 0 on success.
 142 It can return any value on failure, but returns nonzero when
 143 .I mode
 144 is invalid or the request cannot be honoured. It may set
 145 .I errno
 146 on failure.
 147 The other functions are void.
 148 .SH "CONFORMING TO"
 149 The
 150 .B setbuf
 151 and
 152 .B setvbuf
 153 functions conform to ANSI X3.159-1989 (``ANSI C'').
 154 .SH BUGS
 155 The
 156 .B setbuffer
 157 and
 158 .B setlinebuf
 159 functions are not portable to versions of BSD before 4.2BSD, and
 160 are available under Linux since libc 4.5.21.  On 4.2BSD and 4.3BSD systems,
 161 .B setbuf
 162 always uses a suboptimal buffer size and should be avoided.
 163 .P
 164 You must make sure that both
 165 .I buf
 166 and the space it points to still exist by the time
 167 .I stream
 168 is closed, which also happens at program termination.
 169 .P
 170 For example, the following is illegal:
 171 .nf
 172 .sp
 173 #include <stdio.h>
 174 int main()
 175 {
 176     char buf[BUFSIZ];
 177     setbuf(stdin, buf);
 178     printf("Hello, world!\\n");
 179     return 0;
 180 }
 181 .fi
 182 .sp
 183 .SH "SEE ALSO"
 184 .BR fclose (3),
 185 .BR fflush (3),
 186 .BR fopen (3),
 187 .BR fread (3),
 188 .BR malloc (3),
 189 .BR printf (3),
 190 .BR puts (3)