int  fs_setvbuf (FS_FILE    *p_file,
                 char       *p_buf,
                 int         mode,
                 fs_size_t   size);


File

Called from

Code enabled by

fs_api.c

Application

FS_CFG_API_EN and FS_CFG_FILE_BUF_EN

Assign buffer to a file.

Arguments

p_file

Pointer to a file.

p_buf

Pointer to buffer.

mode

Buffer mode:

FS__IONBR

Unbuffered.

FS__IOFBF

Fully buffered.

size

Size of buffer, in octets.

Returned Value

-1, if an error occurs.

0, if no error occurs.

Notes/Warnings

  1. fs_setvbuf() must be used after a stream is opened but before any other operation is performed on stream.
  2. sizemust be more than or equal to the size of one sector; it will be rounded DOWN to the nearest size of a multiple of full sectors.
  3. Once a buffer is assigned to a file, a new buffer may not be assigned nor may the assigned buffer be removed. To change the buffer, the file should be closed and re-opened.
  4. Upon power loss, any data stored in file buffers will be lost.