TStream class

In unit Classes

Base class for streams.

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

TStream is the base class for all streaming classes. It defines methods for reading, writing from and to streams, as well as functions to determine the size of the stream as well as the current position of the stream.

Descendant classes such as TMemoryStream or TFileStream then override these methods to write streams to memory or file.

Properties

`Position`	public	The current position in the stream.
`Size`	public	The current size of the stream.

Methods

`InvalidSeek`	protected
`Discard`	protected
`DiscardLarge`	protected
`FakeSeekForward`	protected
`GetPosition`	protected
`SetPosition`	protected
`GetSize`	protected
`SetSize64`	protected
`SetSize`	protected	Sets the size of the stream.
`ReadNotImplemented`	protected
`WriteNotImplemented`	protected
`ReadMaxSizeData`	protected
`ReadExactSizeData`	protected
`WriteMaxSizeData`	protected
`WriteExactSizeData`	protected
`Read`	public	Reads data from the stream to a buffer and returns the number of bytes read.
`Read64`	public
`Write`	public	Writes data from a buffer to the stream and returns the number of bytes written.
`Write64`	public
`Seek`	public	Sets the current position in the stream.
`ReadData`	public
`ReadBuffer`	public	Reads data from the stream to a buffer.
`ReadBufferData`	public
`WriteBuffer`	public	Writes data from a buffer to the stream.
`WriteData`	public
`WriteBufferData`	public
`CopyFrom`	public	Copy data from one stream to another.
`ReadComponent`	public	Reads component data from a stream.
`ReadComponentRes`	public	Reads component data and resource header from a stream.
`WriteComponent`	public	Write component data to the stream.
`WriteComponentRes`	public	Write resource header and component data to a stream.
`WriteDescendent`	public	Write descendent of a component.
`WriteDescendentRes`	public	Write descendent of a component as resource.
`WriteResourceHeader`	public	Write resource header to the stream.
`FixupResourceHeader`	public	Not implemented in FPC.
`ReadResHeader`	public	Read a resource header from the stream.
`ReadByte`	public	Read a byte from the stream and return its value.
`ReadWord`	public	Read a word from the stream and return its value.
`ReadDWord`	public	Read a DWord from the stream and return its value.
`ReadQWord`	public	Read a QWord value from the stream and return its value.
`ReadAnsiString`	public	Read an ansistring from the stream and return its value.
`ReadUnicodeString`	public
`WriteByte`	public	Write a byte to the stream.
`WriteWord`	public	Write a word to the stream.
`WriteDWord`	public	Write a DWord to the stream.
`WriteQWord`	public	Write a QWord value to the stream.
`WriteAnsiString`	public	Write an ansistring to the stream.
`WriteUnicodeString`	public

Types and constants

DefaultWriteUnitname public

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.