fread

warning

This function starts with lowercase letter.

Description

Read a single line from a file.

NameDescription
handleThe handle of the file to read from (returned by fopen).
stringA string array to store the read text in, passed by reference.
sizeThe number of bytes to read.
packShould the string be packed? True/false.

Returns

The length of string (the read text) as an integer.

Examples

// Open "file.txt" in "read only" mode
new File:handle = fopen("file.txt", io_read),
// Initialize "buf"
buf[128];
// Check, if the file is opened
if (handle)
{
// Success
// Read the whole file
while(fread(handle, buf)) print(buf);
// Close the file
fclose(handle);
}
else
{
// Error
print("The file \"file.txt\" does not exists, or can't be opened.");
}
// Open "file.txt" in "read and write" mode
new File:handle = fopen("file.txt"),
// Initialize "buf"
buf[128];
// Check, if file is open
if (handle)
{
// Success
// Read the whole file
while(fread(handle, buf)) print(buf);
// Set the file pointer to the first byte
fseek(handle, _, seek_begin);
// Write "I just wrote here!" into this file
fwrite(handle, "I just wrote here!");
// Close the file
fclose(handle);
}
else
{
// Error
print("The file \"file.txt\" does not exists, or can't be opened.");
}

Notes

warning

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

Related Functions