Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

setbuf(3c) [sunos man page]

setbuf(3C)						   Standard C Library Functions 						setbuf(3C)

NAME
setbuf, setvbuf - assign buffering to a stream SYNOPSIS
#include <stdio.h> void setbuf(FILE *stream, char *buf); int setvbuf(FILE *stream, char *buf, int type, size_t size); DESCRIPTION
The setbuf() function may be used after the stream pointed to by stream (see intro(3)) is opened but before it is read or written. It causes the array pointed to by buf to be used instead of an automatically allocated buffer. If buf is the null pointer, input/output will be completely unbuffered. The constant BUFSIZ, defined in the <stdio.h> header, indicates the size of the array pointed to by buf. The setvbuf() function may be used after a stream is opened but before it is read or written. The type argument determines how stream will be buffered. Legal values for type (defined in <stdio.h>) are: _IOFBF Input/output to be fully buffered. _IOLBF Output to be line buffered; the buffer will be flushed when a NEWLINE is written, the buffer is full, or input is requested. _IONBF Input/output to be completely unbuffered. If buf is not the null pointer, the array it points to will be used for buffering, instead of an automatically allocated buffer. The size argument specifies the size of the buffer to be used. If input/output is unbuffered, buf and size are ignored. For a further discussion of buffering, see stdio(3C). RETURN VALUES
If an illegal value for type is provided, setvbuf() returns a non-zero value. Otherwise, it returns 0. USAGE
A common source of error is allocating buffer space as an "automatic" variable in a code block, and then failing to close the stream in the same block. When using setbuf(), buf should always be sized using BUFSIZ. If the array pointed to by buf is larger than BUFSIZ, a portion of buf will not be used. If buf is smaller than BUFSIZ, other memory may be unexpectedly overwritten. Parts of buf will be used for internal bookkeeping of the stream and, therefore, buf will contain less than size bytes when full. It is recommended that stdio(3C) be used to handle buffer allocation when using setvbuf(). ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
fopen(3C), getc(3C), malloc(3C), putc(3C), stdio(3C), attributes(5), standards(5) SunOS 5.10 14 Aug 2002 setbuf(3C)

Check Out this Related Man Page

setbuf(3S)																setbuf(3S)

NAME
setbuf(), setvbuf(), setlinebuf() - assign buffering to a stream file SYNOPSIS
Obsolescent Interface DESCRIPTION
can be used after a stream has been opened but before it is read or written. It causes the array pointed to by buf to be used instead of an automatically allocated buffer. If buf is the NULL pointer input/output will be completely unbuffered. A constant defined in the header file, tells how big an array is needed: can be used after a stream has been opened but before it is read or written. type determines how stream is to be buffered. Legal values for type (defined in are: causes input/output to be fully buffered. causes output to be line buffered; the buffer will be flushed when a newline is written, the buffer is full, or input is requested. causes input/output to be completely unbuffered. When an output stream is unbuffered, information is queued for writing on the destination file or terminal as soon as written; when it is buffered, many characters are saved up and written as a block. When the output stream is line-buffered, each line of output is queued for writing on the destination terminal as soon as the line is completed (that is, as soon as a new-line character is written or terminal input is requested). can also be used to explicitly write the buffer. If buf is not the NULL pointer, the array it points to is used for buffering instead of an automatically allocated buffer (from size speci- fies the size of the buffer to be used. The constant in is suggested as a good buffer size. If input/output is unbuffered, buf and size are ignored. By default, output to a terminal is line buffered and all other input/output is fully buffered. is used to change stream from block-buffered or unbuffered to line-buffered. can be used any time the file descriptor is active. Obsolescent Interface assigns buffering to a stream file. DIAGNOSTICS
If an illegal value for type or size is provided, return a non-zero value. Otherwise, the value returned will be zero. Note A common source of error is allocating buffer space as an "automatic" variable in a code block, then failing to close the stream in the same block. Allocating a buffer of size or bytes does not necessarily imply that all of size or bytes are used for the buffer area. AUTHOR
and were developed by HP. SEE ALSO
flockfile(3S), fopen(3S), getc(3S), malloc(3C), putc(3S), stdio(3S), thread_safety(5), glossary(9). STANDARDS CONFORMANCE
setbuf(3S)
Man Page