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.

fgetchar

warning

This function starts with a lowercase letter.

Description

Reads a single character from a file.

Name	Description
File:handle	The file handle to use; returned by fopen.
value	This parameter has no use, just keep it "0".
bool:utf8	If `true`, read a character as UTF-8, otherwise as extended ASCII. (default: `true`)

Returns

If succeed, it returns the extended ASCII or UTF-8 value of the character at the current position in the file, otherwise EOF (end of file).

Examples

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

// Declare "g_char"
new g_char;

// Check, if "file.txt" is open
if (handle)
{
    // Read all characters, while ignoring UTF-8.
    while((g_char = fgetchar(handle, 0, false)) != EOF)
    {
        // Print the character
        printf("[ \"file.txt\" ] 0x%x", g_char);
    }

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