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.
fread
warning
This function starts with a lowercase letter.
Description
Read a single line from a file.
| Name | Description |
|---|---|
| File:handle | The handle of the file to read from (returned by fopen). |
| string[] | A string array to store the read text in, passed by reference. |
| size = sizeof (string) | The number of bytes to read. |
| bool:pack | Should the string be packed? (default: 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"
new 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"
new 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
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.
- 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.
- 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.