FSFile_PosSet()
void FSFile_PosSet (FS_FILE *p_file, FS_FILE_OFFSET offset, FS_FLAGS origin, FS_ERR *p_err);
File | Called from | Code enabled by |
---|---|---|
| Application; | N/A |
Get file position indicator.
See fs_fseek()
for more information.
Arguments
p_file
Pointer to a file.
offset
Offset from the file position specified by origin.
origin
Reference position for offset:
FS_FILE_ORIGIN_START
Offset is from the beginning of the file.
FS_FILE_ORIGIN_CUR
Offset is from the current file position.
FS_FILE_ORIGIN_END
Offset is from the end of the file.
p_err
Pointer to variable that will the receive return error code from the function:
FS_ERR_NONE
File position set successfully.
FS_ERR_NULL_PTR
Argument p_file
passed a NULL pointer.
FS_ERR_INVALID_TYPE
Argument p_file
's type is invalid or unknown.
FS_ERR_FILE_INVALID_ORIGIN
Invalid origin specified.
FS_ERR_FILE_INVALID_OFFSET
Invalid offset specified.
FS_ERR_FILE_NOT_OPEN
File not open.
Returned Value
None.
Notes/Warnings
None.