Flush method

Project: I/O Utility Classes

Unit: PJPipeFilters

Class: TPJUnicodeBMPPipeFilter

Applies to: ~>1.0

procedure Flush;

Description

Flushes any pending un-terminated line of Unicode text from the internal buffer.

If there is any text in the buffer then the OnLineEnd event is triggered for that text as if it was a complete line. If there is no un-terminated text then the event is not triggered.

Remarks

It is not recommended that Flush is called while there is still data in the pipe as this can introduce artificial line breaks in the text.

Flush is called automatically when the filter object is destroyed.

Calling Flush multiple times between pipe reads or after the last read is benign. Once any remaining text has been flushed further calls to the method have no effect.