Skip to main content

fseek

warning

This function starts with a lowercase letter.

Description​

Change the current position in the file. You can either seek forward or backward through the file.

NameDescription
File:handleThe file handle to use. Returned by fopen.
positionThe new position in the file, relative to the parameter whence (see below).
seek_whence:whenceThe starting position to which parameter position relates.

Returns​

The new position; relative to the start of the file.

Examples​

// Open "file.txt" in "read only" mode
new File:handle = fopen("file.txt", io_read);

// If "file.txt" is open
if (handle)
{
    // Success

    // Jump to the 1st byte of "file.txt", and print its position
    printf("Begin of file position: %d", fseek(handle, 0, seek_start));

    // Jump to the last byte of "file.txt", and print its position
    printf("End of file position: %d", fseek(handle, 0, seek_end));

    // Jump to the same byte of "file.txt", and print its position
    printf("Currrent file position: %d", fseek(handle, 0, seek_current));

    // Close "file.txt"
    fclose(handle);
}
else
{
    // Error
    print("Failed to open \"file.txt\".");
}

Notes​

warning

Using an invalid handle will crash your server! Get a valid handle by using fopen or ftemp.

  • fopen: Open a file.
  • fclose: Close a file.
  • ftemp: Create a temporary file stream.
  • fremove: Remove a file.
  • fwrite: Write to a file.
  • fread: Read a file.
  • fputchar: Put a character in a file.
  • fgetchar: Get a character from a file.
  • fblockwrite: Write blocks of data into a file.
  • fblockread: Read blocks of data from a file.
  • flength: Get the file length.
  • fexist: Check, if a file exists.
  • fmatch: Check, if patterns with a file name matches.
  • ftell: Get the current position in the file.
  • fflush: Flush a file to disk (ensure all writes are complete).
  • fstat: Return the size and the timestamp of a file.
  • frename: Rename a file.
  • fcopy: Copy a file.
  • filecrc: Return the 32-bit CRC value of a file.
  • diskfree: Returns the free disk space.
  • fattrib: Set the file attributes.
  • fcreatedir: Create a directory.