TStream object

In unit Objects

Base stream class.

Declaration

pascal

TStream = class(TObject)

Inheritance

TStream
TObject

Descends from it: TBufBlobStream TCachedDataStream TCustomMemoryStream TDosStream TGZFileStream TGZipCompressionStream TGZipDecompressionStream THandleStream TMemoryStream TOwnerStream TProxyAggregateStream TProxyStream TResourceDataStream

Description

The TStream object is the ancestor for all streaming objects, i.e. objects that have the capability to store and retrieve data.

It defines a number of methods that are common to all objects that implement streaming, many of them are virtual, and are only implemented in the descendent types.

Programs should not instantiate objects of type TStream directly, but instead instantiate a descendant type, such as TDosStream, TMemoryStream.

Methods

`Init`		Constructor for TStream instance.
`Get`		Read an object definition from the stream.
`StrRead`		Read a null-terminated string from the stream.
`GetPos`		Return current position in the stream.
`GetSize`		Return the size of the stream.
`ReadStr`		Read a shortstring from the stream.
`Open`		Open the stream.
`Close`		Close the stream.
`Reset`		Reset the stream.
`Flush`		Flush the stream data from the buffer, if any.
`Truncate`		Truncate the stream size on current position.
`Put`		Write an object to the stream.
`StrWrite`		Write a null-terminated string to the stream.
`WriteStr`		Write a pascal string to the stream.
`Seek`		Set stream position.
`Error`		Set stream status.
`Read`		Read data from stream to buffer.
`Write`		Write a number of bytes to the stream.
`CopyFrom`		Copy data from another stream.

Fields

`Status`		Current stream status.
`ErrorInfo`		Additional error info when there is an error.
`StreamSize`		Current size of the stream.
`Position`		Current Stream position.
`TPCompatible`		If set to True streamed data is written in a TP compatible format.

Inherited

From TObject (42)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance Create DefaultHandler DefaultHandlerStr Destroy Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.