ObjectType:file
Jump to navigation
Jump to search
Description
Members
- bool Open: TRUE if the file is open
- filepath Path: Full path to this file
- string Filename: Filename of this file
- string Read: Reads a line from this file, up to 1024 characters long (result includes carriage return)
- string Read[#]: Reads a line from this file, up to # characters long (result includes carriage return)
- int ReadBinary[buffer variable,#]: Reads # bytes into the specified buffer. Result is the number of bytes read.
- int Position: Current position within the file
- int Size: Size of the file
- bool EOF: TRUE if the previous Read or ReadBinary hit the end of the file
Methods
- SetFilename[filename]: Sets the full path and filename. Only valid while file is closed.
- Open: Opens the file
- Open[readonly]: Opens the file in read-only mode
- Close: Closes the file
- Write[text]: Writes the given text to the file
- WriteBinary[buffer variable,#]: Writes # bytes from the given buffer variable to the file
- Seek[#]: Seeks to the specified position within the file
- SeekEnd: Seeks to the end of the file
- Skip[#]: Skips # bytes within the file
- Truncate: Truncates the file at the current position (all data after this point in the file is removed)
Returns
The full path and filename to this file
