Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-FileCauxis()
Cauxout()
Bconin()
Cauxin()                                                             GEMDOS

Syntax

WORD Cauxin( VOID )

Function      Cauxin() waits for the next available data byte from GEMDOS
              handle 2 (normally device 'aux:') and when available,
              returns it in the low byte of the returned WORD.

Opcode        3 (0x03)

Availability  All GEMDOS versions.

Binding       move.w  #$3,-(sp)
              trap    #1
              addq.l  #2,sp

Return Value  The WORD value contains the retrieved byte in the lower
              eight bits. The contents of the upper 8 bits are currently
              undefined.

Caveats       This function can cause flow control problems. When using
              this function while its handle is redirected, an end-of-file
              condition will hang the system. GEMDOS version 0.30 and all
              MiNT versions correct this bug. MiNT returns MINT_EOF
              (0xFF1A) when the end-of-file is reached. In addition, if
              this handle is redirected to something other than 'aux:', an
              end-of-file will hang the system. Besides these known bugs,
              this function is used by many 'C' compilers to redirect
              standard error messages. It is therefore advisable to use
              Bconin() instead.

See Also      Cauxis(), Cauxout(), Bconin()