File (gb)

This class is used for representing a file opened with the OPEN instruction, accessing standard input, output and error streams, and manipulating file paths with its static methods.

You cannot create this class directly. You must use the OPEN instruction.

This class inherits Stream.

This class is not creatable.

Static properties
DefaultDirAuth   Return or set the default authorizations used when creating a new directory with MKDIR.
Err   Returns the standard error output stream.
In   Returns the standard input stream.
Out   Returns the standard output stream.

Static methods
BaseName   Returns the name of a file without its extension.
Dir   Returns the directory component of a file path.
Ext   Returns the extension of a file name.
IsHidden   Return if a file path is hidden.
IsRelative   Return True if Path is a relative path.
Load   Loads a file and returns its contents as a string.
Name   Returns the name component of a file path.
RealPath   Return the the canonicalized absolute pathname of a path, with no symbolic links inside.
Save   Saves the contents of a string into a file.
SetBaseName   Sets the base name of a path, and returns the modified path.
SetDir   Sets the directory part of a path, and returns the modified path.
SetExt   Sets the file extension of a path, and returns the modified path.
SetName   Sets the file name part of a path, and returns the modified path.

Inherited properties
Blocking   Returns or sets if the stream is blocking.
ByteOrder   Returns or sets the byte order used to read or write binary data to the stream.
EndOfFile   This property signals whether the last use of LINE INPUT reached the end of file, instead of reading a full line with an end-of-line character.
EndOfLine   Return or set the newline separator used by this stream.
Eof   Return if a stream reached its end.
Handle   Returns the system file descriptor associated with this Stream.
IsTerm   Return if a stream is associated with a terminal.
Lines   Returns a virtual object that allows you to enumerate a stream line by line.
NullTerminatedString   Return or set if strings are null-terminated when they are serialized.
Tag   Returns or sets the tag associated with the stream.
Term   Return a virtual object that allows to manage the terminal associated with the stream.

Inherited methods
Begin   Start to buffer data written to the stream, so that everything will be sent when the Send method is called.
Close   Closes the stream.
Drop   Drop the data that has been buffered since the last call to the Begin method.
ReadLine   Read a line of text from the stream, like the LINE INPUT instruction.
Send   Send all the data, in one shot, since the last call to Begin.
Watch   Start or stop watching the stream file descriptor for reading or writing, after it has been opened.

Read   This event is raised when there is something to read from the file.
Resize   This special event is raised by the File.In stream when the control terminal of the process is resized.
Write   This event is raised when writing to the file is possible.