Fread

fread

Description:

Function fread read a single line from a file.

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

This function name starts with a lowercase letter.

Parameters:

(File:handle, string[], size = sizeof string, bool: pack = false)

int

handle

The handle of the file to read from (returned by fopen).

string

string

A string array to store the read text in, passed by reference.

int

size

The number of bytes to read.

bool

pack

Should the string be packed? true/false.

Return Values:

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

Examples:

Example 1Example 2

// 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.");
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• fopen: Open a file (to read from or write to).
• fclose: Close a file.
• ftemp: Create a temporary file stream.
• fremove: Remove a file.
• fwrite: Write to 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.
• flength: Get the file length.
• fexist: Check, if a file exists.
• fmatch: Check, if patterns with a file name matches.