JVCL Help:TJvCustomAppStorage.ReadList

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Reads a list of items.


Pascal

 functionReadList(constPath: string; constList: TObject; constOnReadItem: TJvAppStorageListItemEvent; constItemName: string = cItem): Integer;


Parameters

Parameters Description
const Path: string Path (relative to the current path) of the value to read.
const List: TObject Parameter passed to the OnReadItem event.
const OnReadItem: TJvAppStorageListItemEvent Method that will read each item from the storage.
const ItemName: string = cItem Parameter passed to the OnReadItem event.


Description

ReadList reads a list of items from the storage. The result value is the number of items in the list or 0 if the list does not exist in the storage. ReadList is a general purpose method that can read any list by means of the provided read method. The specified method will be called for each item individually, specifying the list path and the item index to read. The method should read the item (which can be as simple as reading in a single value to as complex as reading in an entire group of values and/or sub lists) and process the data immediately (e.g. store it in memory or display it in a control).


See Also

TJvCustomAppStorage.ReadBinary, TJvCustomAppStorage.ReadDateTime, TJvCustomAppStorage.ReadFloat, TJvCustomAppStorage.ReadInteger, TJvCustomAppStorage.ReadString, TJvCustomAppStorage.ReadStringList, TJvCustomAppStorage.WriteList


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page