fgetchar

warning

This function starts with lowercase letter.

Description

Reads a single character from a file.

NameDescription
handleThe file handle to use; returned by fopen.
valueThis parameter has no use, just keep it "0".
utf8If true, read a character as UTF-8, otherwise as extended ASCII.

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"
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