Fgetchar

fgetchar

Description:

Function fgetchar reads a single character 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, value, bool: utf8 = true)

int

handle

The file handle to use; returned by fopen.

int

value

This parameter has no use, just keep it "0".

{{Param|{{bool]]|utf8|If true, read a character as UTF-8, otherwise as extended ASCII.}}

Return Values:

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:

Example 1

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

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