setvbuf
Defined in header <stdio.h>
|
||
(until C99) | ||
(since C99) | ||
Changes the the buffering mode of the given file stream stream
as indicated by the argument mode
. In addition,
- If
buffer
is a null pointer, resizes of the internal buffer tosize
. - If
buffer
is not a null pointer, instructs the stream to use the user-provided buffer of sizesize
beginning atbuffer
. The stream must be closed (with fclose) before the lifetime of the array pointed to bybuffer
ends. The contents of the array after a successful call tosetvbuf
are indeterminate and any attempt to use it is undefined behavior.
Parameters
stream | - | the file stream to set the buffer to or null pointer to change size and mode only | ||||||
buffer | - | pointer to a buffer for the stream to use | ||||||
mode | - | buffering mode to use. It can be one of the following values:
| ||||||
size | - | size of the buffer |
Return value
0 on success or nonzero on failure.
Notes
This function may only be used after stream
has been associated with an open file, but before any other operation (other than a failed call to setbuf/setvbuf
).
Not all size
bytes will necessarily be used for buffering: the actual buffer size is usually rounded down to a multiple of 2, a multiple of page size, etc.
On many implementations, line buffering is only available for terminal input streams.
A common error is setting the buffer of stdin or stdout to an array whose lifetime ends before the program terminates:
The default buffer size BUFSIZ is expected to be the most efficient buffer size for file I/O on the implementation, but POSIX fstat often provides a better estimate.