JVCL Help:TJvCustomAppStorage.ReadObjectList@string@TList@Boolean@string

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

Search in JVCL Help

 
Search in all projects
 

Summary

Retrieves a list of objects.


Pascal

 functionReadObjectList(constPath: string; List: TList; constClearFirst: Boolean = True; constItemName: string = cItem): Integer; overload;
functionReadObjectList(constPath: string; List: TList; ItemCreator: TJvAppStorageObjectListItemCreateEvent; constClearFirst: Boolean = True; constItemName: string = cItem): Integer; overload;


Parameters

Parameters Description
const Path: string Path (relative to the current path) of the value to read.
List: TList Specifies the TList descendant to hold the retrieved objects.
const ClearFirst: Boolean = True Indicates whether to clear the List parameter first.
const ItemName: string = cItem Prefix of the sub path for the items.
ItemCreator: TJvAppStorageObjectListItemCreateEvent Method that will create each item.


Description

Retrieves a list of objects. The list is optionally cleared before before reading starts.
When ReadObjectList is called with no ItemCreater parameter, the ObjectType of the Object is retrieved from the stored "Classname" value. Otherwise, the ObjectType of the Object is defined by the ItemCreator-Event.
The result value is the number of items read. Uses ReadList with internally provided methods to do the actual reading.


See Also

TJvCustomAppStorage.ReadList


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