fs_fgetpos()

int  fs_fgetpos (FS_FILE    *p_file,
                 fs_fpos_t  *p_pos);

File

Called from

Code enabled by

fs_api.c

Application

FS_CFG_API_EN

Get file position indicator.

Arguments

p_file

Pointer to a file.

p_pos

Pointer to variable that will receive the file position indicator.

Returned Value

0, if no error occurs.

Non-zero value, otherwise.

Notes/Warnings

  1. The return value should be tested against 0:

    rtn = fs_fgetpos(p_file, &pos);
    if (rtn == 0) {
        // No error occurred
    } else {
        // Handle error
    }
  2. The value placed in pos should be passed to FS_fsetpos() to reposition the file to its position at the time when this function was called.