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 seek(offset, origin)
  17 Seek to an offset from the origin.
  18
  19 argument::offset
  20 an offset in bytes.
  21
  22 argument::origin
  23 one of the following link::Classes/Integer::s:
  24 definitionList::
  25 ## 0 || seek from beginning of file.
  26 ## 1 || seek from current position in file.
  27 ## 2 || seek from end of file.
  28 ::
  29
  30 method::write(item)
  31 Writes an item to the file.
  32
  33 argument::item
  34 one of the following:
  35 definitionList::
  36 ## link::Classes/Float:: ||
  37 ## link::Classes/Integer:: ||
  38 ## link::Classes/Char:: ||
  39 ## link::Classes/Color:: ||
  40 ## link::Classes/Symbol:: || writes the name of the Symbol as a C string.
  41 ## link::Classes/RawArray:: || write the bytes from any RawArray in big endian.
  42 ::
  43
  44 method::getLine
  45 reads and returns a link::Classes/String:: up to lesser of next newline or 1023 chars.
  46
  47 method::getChar
  48 read one byte and return as a link::Classes/Char::.
  49
  50 method::getInt8
  51 read one byte and return as a link::Classes/Integer::.
  52
  53 method::getInt16
  54 read two bytes and return as an link::Classes/Integer::.
  55
  56 method::getInt32
  57 read four bytes and return as an link::Classes/Integer::.
  58
  59 method::getFloat
  60 read four bytes and return as a link::Classes/Float::.
  61
  62 method::getDouble
  63 read eight bytes and return as a link::Classes/Float::.
  64
  65 method::putChar
  66 write a link::Classes/Char:: as one byte.
  67
  68 method::putInt8
  69 write an link::Classes/Integer:: as one byte. That is a signed link::Classes/Integer:: value between -128 and 127.
  70
  71 method::putInt16
  72 write an link::Classes/Integer:: as two bytes.
  73
  74 method::putInt32
  75 write an link::Classes/Integer:: as four bytes.
  76
  77 method::putFloat
  78 write a link::Classes/Float:: as four bytes.
  79
  80 method::putDouble
  81 write a link::Classes/Float:: as eight bytes.
  82
  83 method::putString
  84 write a null terminated link::Classes/String::.