RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > GStreams > Classes

TGTextStream Class

The TGTextStream class is a buffered metastream for reading text from and writing text to a stream. The TGTextStream class is a TGBufferStream descendant. It works by manipulating another stream (assigned at construction). The TGTextStream class provides many help methods to read and write values as text to the stream. The TGTextStream class is an excellent class for parsing text files.

The TGTextStream class is based largely on the TS_TextStream class from "Secrets of Delphi 2" by Ray Lischner. Modified and used here by his kind permission.

Namespace: GStreams

	Name	Description
	Create(String,Word,TEncoding)	Overloaded. The constructor creates and allocates the memory for the text stream. This constructors also creates and manages a TFileStream object for reading or writing to the specified file. The Mode parameter indicates how the file is to be opened. The Mode parameter consists of an open mode and a share mode or'ed together. The open mode must be one of the following values:
fmCreate	Create a file with the given name. If a file with the given name exists, open the file in write mode.
fmOpenRead	Open the file for reading only.
fmOpenWrite	Open the file for writing only. Writing to the file completely replaces the current contents.
fmOpenReadWrite	Open the file to modify the current contents rather than replace them.

The share mode must be one of the following values:

fmShareCompat

Sharing is compatible with the way FCBs are opened.

fmShareExclusive

Other applications can not open the file for any reason.

fmShareDenyWrite

Other applications can open the file for reading but not for writing.

fmShareDenyRead

Other applications can open the file for writing but not for reading.

fmShareDenyNone

No attempt is made to prevent other applications from reading from or writing to the file.

If the file can not be opened, Create raises an exception.

public constructor

Create(TStream,TEncoding)

Overloaded. Initializes a new instance of the TGTextStream class.

public destructor

Destroy

Represents the destructor of the TGTextStream class. (Overrides GStreams.TGBufferStream.Destroy.)

Top

	Name	Description
	Buffer	Represents property Buffer. (Inherited from GStreams.TGBufferStream.)
	BufferEnd	Represents property BufferEnd. (Inherited from GStreams.TGBufferStream.)
	BufferPosition	Represents property BufferPosition. (Inherited from GStreams.TGBufferStream.)
	BufferPtr	Represents property BufferPtr. (Inherited from GStreams.TGBufferStream.)
	BufferSize	The BufferSize property specifies the size of the buffer created by the stream, i.e., the smallest number of bytes that are read or written at once (except for when the buffer is flushed). The size of the buffer can make a big difference in the efficiency of the object. The default buffer size is 8192 bytes. (Inherited from GStreams.TGBufferStream.)
	Delimiters	Used by the metastream when it is trying to tokenize the text being read in. The delimiters define the "borders" of a token.
	Encoding	The encoding used in the stream
	OnFillBuffer	Occurs whenever the buffer is refilled from the stream. Write an OnFillBuffer event when you want to take action every time the buffer is filled.
	OnFlushBuffer	Occurs when the buffer is flushed of all of its contents and written to the stream. Write an OnFlushBuffer event handler when you want to take some action when the buffer is flushed.
	OwnStream	Represents property OwnStream.
	PreambleStreamed	Represents property PreambleStreamed.
	State	Specifies whether the buffer is being used for reading or writing. The unknown state occurs when the buffer is created, flushed, or the stream has been completely read.
	Stream	Represents property Stream. (Inherited from GStreams.TGBufferStream.)

Top

	Name	Description
	Close	Closes and flushes the buffer. (Inherited from GStreams.TGBufferStream.)
	FillBuffer	Represents method FillBuffer. (Overrides GStreams.TGBufferStream.FillBuffer.)
	FlushBuffer	Represents method FlushBuffer. (Inherited from GStreams.TGBufferStream.)
	Format(String,TVarRec[])	Formats the argument parameters using the format string passed in the Fmt parameter. The formatting is identical to using the Format pascal procedure and calling the WriteArgs method. To write the arguments out as one formatted line, use the FormatLn method.
	FormatLn(String,TVarRec[])	Formats the argument parameters using the format string passed in the Fmt parameter and writes it out as a line of text (places the end of line characters after the string). The formatting is identical to using the Format pascal procedure and calling the WriteLn method. To write the arguments out as just a string, use the Format method.
	FreeStream	Represents method FreeStream.
	GetChar	Overloaded. Returns the next character in the stream.
	GetChar(Char)	Overloaded.
	GetFloat	Returns the next token in the stream as a floating point number. The method advances from the current position in the stream until the next non-whitespace character is found (including carriage returns and line feeds).
	GetInteger	Returns the next token in the stream as an integer number. The method advances from the current position in the stream until the next non-whitespace character is found (including carriage returns and line feeds).
	GetLine	Returns a string containing all the characters in the stream from the current position until a carriage return or linefeed character is found.
	GetToken	Overloaded. Returns a string containing all the characters in the stream until a character is found that is in the Delimiters property.
	GetToken(String,Boolean)	Overloaded. Returns a string containing all the characters in the stream until a character is found that is in the Delimiters parameter. The RestoreOld parameter controls whether the object restores the old delimiters (in the Delimiters property) after the token is found
	IsEof	Returns true if the stream is at the end of file. (Inherited from GStreams.TGBufferStream.)
	PreambleSize	Represents method PreambleSize.
	PrepareBuffer	Represents method PrepareBuffer. (Overrides GStreams.TGBufferStream.PrepareBuffer.)
	Put(AnsiChar)	Overloaded. Places the character parameter into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	Put(Extended)	Overloaded. Places the floating point parameter into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	Put(Integer)	Overloaded. Places the integer parameter into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	Put(String)	Overloaded. Places the string parameter into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	Put(WideChar)	Overloaded. Places the wide character parameter into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	PutBack(Byte)	Overloaded. Represents method PutBack(Byte). (Inherited from GStreams.TGBufferStream.)
	PutBack(Char)	Overloaded. Represents method PutBack(Char). (Overrides GStreams.TGBufferStream.PutBack(Char).)
	PutEOL	Places an end of line character (#13#10) into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	PutLine(String)	Places the string parameter into the text stream, end of line characters (#13#10), and then returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	PutSpace	Places a space into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	PutTab	Places a tab character into the text stream and returns the text stream. The text stream is returned to allow you to chain together Put method calls (for example, Put('a').Put(123).PutEOL).
	Read(Void,Longint)	Represents method Read(Void,Longint). (Inherited from GStreams.TGBufferStream.)
	Seek(Longint,Word)	Represents method Seek(Longint,Word). (Overrides GStreams.TGBufferStream.Seek(Longint,Word).)
	SeekExcludePreamble(Longint,Word)	Represents method SeekExcludePreamble(Longint,Word).
	SkipInLineSpaces	Skips the whitespace in the current line, it does not consider the end of line characters to be whitespace. The function returns TRUE if the end of line was encountered, FALSE otherwise. To skip all whitespace including the end of line characters, use the SkipSpaces method.
	SkipSpaces	Skips whitespace until a non-whitespace character is found, the end of line characters are also considered to be whitespace. To skip whitespace only in the current line, use the SkipInLineSpaces method.
	Write(Void,Longint)	Represents method Write(Void,Longint). (Inherited from GStreams.TGBufferStream.)
	WriteArgs(TVarRec[])	Writes the arguments out to the stream. The method puts a space between every argument so that they may be properly parsed later. To write out a group of arguments and terminate it with the end of line characters, use the WriteLn method.
	WriteLn(TVarRec[])	Writes the arguments out to the stream and terminates them with the end of line characters. The method puts a space between every argument so that they may be properly parsed later. To write out a group of arguments unterminated, use the WriteArgs method.

Top

RiverSoftAVG Products Help

Reference