warning Not Translated

This page has not been translated into the language that your browser requested yet. The English content is being shown as a fallback.

If you want to contribute a translation for this page then please click here.

fblockread

warning

This function starts with a lowercase letter.

Description

This function allows you to read data from a file, without encoding and line terminators

Name	Description
File:handle	File handle to use, opened by fopen()
buffer	The buffer to save the read data in.
size = sizeof (buffer)	The number of cells to read.

Returns

The number of cells read. Zero, if the file end has been reached.

Examples

// Define "some_enum"
enum _:some_enum
{
    some_data1,
    some_data2[20],
    Float:some_data3
}

// Declare "some_data"
new some_data[some_enum];

// ...

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

// Declare "file_len"
new file_len;

// Check, if "file.bin" is open
if (handle)
{
    // Success

    // Get the file length of "file.bin"
    file_len = flength(handle);

    // If file is equally larger than the array
    if (file_len == (some_enum*4))
    {
        // Success

        // Read from "file.bin" into "some_data"
        fblockread(handle, some_data);
    }
    else
    {
        // Error
        print("\"file.bin\" is not compatible with the array.");
    }

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

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