Fgetchar

From SA-MP Wiki

Jump to: navigation, search

fgetchar

Image:Farm-Fresh text lowercase.png Note: This function name starts with a lowercase letter.


Description:

Reads a single character from a file.


Image:32px-Circle-style-warning.png

Warning

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


Parameters:
(File: handle, value, bool: utf8=true)
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.


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


Example Usage:

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

Related Functions

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


  • ftemp: Create a temporary file stream.
  • fgetchar: Get a character from a file.
  • fseek: Jump to a specific character in a file.
  • fexist: Check, if a file exists.
  • fmatch: Check, if patterns with a file name matches.
Personal tools