FS_SeekFile

C Specification

#include <nitro/fs.h>

BOOL FS_SeekFile( FSFile *p_file, s32 offset, FSSeekMode origin );

Arguments

p_file Address of the FSFile structure
offset The number of bytes to move (in a positive direction from the beginning toward the end).
origin The move base position

Return Values

If the file pointer is correctly moved, it returns TRUE. Otherwise it returns FALSE.

Description

This moves the file pointer from a base point that is specified by origin to a position that is offset by the amount that is specified by offset. The origin type is defined by the FSSeekFileMode type. If the specified position is before the beginning of the file, the file pointer will move to the beginning. If the specified position is after the end of the file, the file pointer will move to the end.

See Also

FSFile, FSSeekFileMode, FS_GetLength, FS_ReadFile, FS_SeekFileToBegin, FS_SeekFileToEnd

Revision History

04/01/2004 Initial version.