Welcome to the new DelphiDabbler Code Library Documentation.

This is a new site that's currently running on alpha code. There are going to be bugs. If you discover any, please report them on the site's issues page (GitHub account required). Thanks.

Warning: Many URLs are going to change. Refer to the README file to discover which library project's documentation has been completed.

TPJAnsiSBCSPipeFilter class

Project: I/O Utility Classes

Unit: PJPipeFilters

Applies to: ~>1.0

Description

This pipe filter class constructs valid ANSI strings from chunks of data read from a pipe.

An event is triggered for each string read. Strings are also parsed into lines that are divided by a specified end of line marker. Each complete line read is notified to the user via another event.

The class only works for Single Byte Character Set (SBCS) strings, i.e. those that take exactly one byte per character. It is the caller’s responsibility to interpret the string’s code page correctly.

TPJAnsiSBCSPipeFilter descends from TPJPipeFilter

Methods

Methods introduced in this class

The only method introduced in this class is an override of TObject.AfterConstruction to set default property values. There is no need to call this method directly.

Methods inherited from TPJPipeFilter

Method Description
Create Object constructor. Sets up object to filter a specified pipe.
ReadPipe Reads all available data from the pipe.
Flush Flushes any unprocessed buffered data.
HaveUnprocessedData Checks there is currently any buffered, unprocessed, data.

Properties

Properties introduced in this class

Property Description
EOLMarker End of line marker used when parsing text into lines.

Properties inherited from TPJPipeFilter

Property Description
Pipe Read only property providing access to the pipe that is being filtered.

Events

Event Description
OnLineEnd Event triggered when each end of line is reached.
OnText Event triggered whenever valid text is read from pipe.

No events are inherited.