BuffStream
(Engine-Level Function)
Description: | Returns an in-memory read/write (expanding) buffer stream. |
Returns: | Buffer |
Usage: | Script Only. |
Function Groups: | Stream and Socket, String and Buffer |
Related to: | BuffRead | BuffWrite | CloseStream | GetStreamLength | PeekStream | Seek | ShiftStream | SRead | StreamEnd | SWrite |
Format: | BuffStream(Buffer) |
Parameters: |
Buffer |
Required. Any text or buffer expression. This serves as the initial content of the stream. |
Comments:
This function returns a stream with the contents of Buffer. The pointer at which an action (read or write) begins will be at the start of the stream. Writing to this stream can overwrite or expand (or both,) the size of this initial stream. In-memory stream can be considerably faster to work with than disk-based streams. Streams can be easier to work with than their older text-buffer counterparts.
Example
Stream = BuffStream("0123456789");
In this example, the variable Stream would contain "0123456789".