InStream Data type
Version: Available or changed with runtime version 1.0.
Is a generic stream object that you can use to read from or write to files and BLOBs. You can define the internal structure of a stream as a flat stream of bytes. You can assign one stream to another. Reading from and writing to a stream occurs sequentially.
Instance methods
The following methods are available on instances of the InStream data type.
| Method name | Description |
|---|---|
| EOS() | Indicates whether an input stream has reached End of Stream (EOS). |
| Length() | Gets the stream length. |
| Position([BigInteger]) | Get or set the current stream position in seekable streams. |
| Read(var Boolean [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Byte [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Char [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Integer [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var BigInteger [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Decimal [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Guid [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Text [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| Read(var Any [, Integer]) | Reads a specified number of bytes from an InStream object. Data is read in binary format. |
| ReadText(var Text [, Integer]) | Reads text from an InStream object. |
| ResetPosition() | Resets the stream position on an InStream object. |