HelpSource/Classes/UnixFILE.schelp

   1 class:: UnixFILE
   2 summary:: An abstract class
   3 related:: Classes/File, Classes/Pipe
   4 categories:: Files
   5
   6 InstanceMethods::
   7
   8 private::prGetLine, addOpenFile
   9
  10 method::isOpen
  11 Returns whether the file is open. An open request can fail if a file cannot be found for example. This method lets you test that the open call succeeded.
  12
  13 method::pos
  14 Answer the current file position
  15
  16 argument::offset
  17 an offset in bytes.
  18
  19 argument::origin
  20 one of the following link::Classes/Integer::s:
  21 definitionList::
  22 ## 0 || seek from beginning of file.
  23 ## 1 || seek from current position in file.
  24 ## 2 || seek from end of file.
  25 ::
  26
  27 method::write
  28 Writes an item to the file.
  29
  30 argument::item
  31 one of the following:
  32 definitionList::
  33 ## link::Classes/Float:: ||
  34 ## link::Classes/Integer:: ||
  35 ## link::Classes/Char:: ||
  36 ## link::Classes/Color:: ||
  37 ## link::Classes/Symbol:: || writes the name of the Symbol as a C string.
  38 ## link::Classes/RawArray:: || write the bytes from any RawArray in big endian.
  39 ::
  40
  41 method::getLine
  42 reads and returns a link::Classes/String:: up to lesser of next newline or 1023 chars.
  43
  44 method::getChar
  45 read one byte and return as a link::Classes/Char::.
  46
  47 method::getInt8
  48 read one byte and return as a link::Classes/Integer::.
  49
  50 method::getInt16
  51 read two bytes and return as an link::Classes/Integer::.
  52
  53 method::getInt32
  54 read four bytes and return as an link::Classes/Integer::.
  55
  56 method::getFloat
  57 read four bytes and return as a link::Classes/Float::.
  58
  59 method::getDouble
  60 read eight bytes and return as a link::Classes/Float::.
  61
  62 method::putChar
  63 write a link::Classes/Char:: as one byte.
  64
  65 method::putInt8
  66 write an link::Classes/Integer:: as one byte. That is a signed link::Classes/Integer:: value between -128 and 127.
  67
  68 method::putInt16
  69 write an link::Classes/Integer:: as two bytes.
  70
  71 method::putInt32
  72 write an link::Classes/Integer:: as four bytes.
  73
  74 method::putFloat
  75 write a link::Classes/Float:: as four bytes.
  76
  77 method::putDouble
  78 write a link::Classes/Float:: as eight bytes.
  79
  80 method::putString
  81 write a null terminated link::Classes/String::.