System.Classes.TReader.ReadListEnd

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

procedure ReadListEnd; inline;

C++

void __fastcall ReadListEnd(void);

Properties

Type Visibility Source Unit Parent
procedure
function
public
System.Classes.pas
System.Classes.hpp
System.Classes TReader

Description

Reads an end-of-list marker from the reader object's associated stream.

ReadListEnd is used by other methods that iterate through a list of items to signal the end of a group of items being read. ReadListEnd is also used by component writers in defined property ReadData methods.

A call to ReadListEnd is generally preceded by a reading loop that terminates when the EndOfList method returns true, indicating that an end-of-list marker is next on the stream.

If the item read is not an end-of-list marker, ReadListEnd raises an EReadError exception. A call to ReadListEnd must correspond to a preceding call to ReadListBegin.

See Also