Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File5.10.13  Fgetchar                                                  TOS

 Name:         »Fgetchar« - Read a character from a file.

 Opcode:       263

 Syntax:       int32_t Fgetchar ( int16_t fh, int16_t mode );

 Description:  The function reads a character from the file with the 
               handle fh. The parameter mode is only of interest when 
               the opened file is a (pseudo-)terminal. In that case 
               the following values apply:

                mode  Meaning

                0     Raw mode
                      No evaluation of control characters
                1     Cooked mode
                      Special control characters (Control-C, Control- 
                      Z) will be looked for and interpreted if 
                      appropriate; the same applies for flow control 
                      (Control-S, Control-Q)
                2     Echo mode
                      Read characters will be output on the terminal

               The ASCII value of the character read will be stored in 
               the low byte of the LONG returned by the function. For 
               cases where the file is a (pseudo-)terminal, the 
               scancode and Shift status will be returned as for 
               Bconin.

               The individual modes of mode can naturally also be 
               combined with an OR operation.

               Warning: This function is optional, hence a call may be 
               answered with EINVFN.

 Return value: The function can return the following results:

                >= 0 :    No error, but the read character
                0xff1a :  End-of-File (EOF) was recognized
                EIHNDL :  Invalid file handle

 Availability: As of the first in MultiTOS integrated MiNT version 
               1.04.

 Group:        File functions

 See Also:     Binding   Bconin   Cconin   Cauxin   Fputchar   Fread