compiler/arossupport/readbyte.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Read a big endian byte from a streamhook
   6     Lang: english
   7 */
   8
   9 #include <proto/dos.h>
  10
  11 /******************************************************************************
  12
  13     NAME */
  14 #include <stdio.h>
  15 #include <aros/bigendianio.h>
  16 #include <proto/alib.h>
  17
  18         BOOL ReadByte (
  19
  20 /*  SYNOPSIS */
  21         struct Hook * hook,
  22         UBYTE       * dataptr,
  23         void        * stream)
  24
  25 /*  FUNCTION
  26         Reads one big endian 8bit value from a streamhook.
  27
  28     INPUTS
  29         hook - Streamhook
  30         dataptr - Put the data here
  31         stream - Read from this stream
  32
  33     RESULT
  34         The function returns TRUE on success. On success, the value
  35         read is written into dataptr. On failure, FALSE is returned and the
  36         contents of dataptr are not changed.
  37
  38     NOTES
  39         This function reads big endian values from a streamhook even on
  40         little endian machines.
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47         ReadByte(), ReadWord(), ReadLong(), ReadFloat(), ReadDouble(),
  48         ReadString(), ReadStruct(), WriteByte(), WriteWord(), WriteLong(),
  49         WriteFloat(), WriteDouble(), WriteString(), WriteStruct()
  50
  51     HISTORY
  52         14.09.93    ada created
  53
  54 ******************************************************************************/
  55 {
  56     LONG value;
  57
  58     struct BEIOM_Read rd = {BEIO_READ};
  59
  60     value = CallHookA (hook, stream, &rd);
  61
  62     if (value != EOF)
  63         *dataptr = value;
  64
  65     return (value != EOF);
  66 } /* ReadByte */
  67