note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

flength

warning

This function starts with a lowercase letter.

Description

Returns the length of a file.

Name	Description
File:handle	The file handle returned by fopen or ftemp

Returns

The length of a file, in bytes.

Examples

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

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

    // Print the size oin bytes of "file.txt"
    printf("File size: %d", flength(handle));

    // 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.

Related Functions

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.
fseek: Jump to a specific character in a file.
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.