Collection that encapsulates an FTP directory listing.

TIdFTPListItems = class(TCollection)

TIdFTPListItems is a TCollection descendant that encapsulates an FTP directory listing, and contains individual TIdFTPListItem objects for each entry in the listing.

File system directory represented by entries in the collection.

property DirectoryName: string;

DirectoryName is a public String property that indicates the name of the file system directory represented by the entries in the collection. Use Items to access the entries in the directory listing. Changing the value in DirectoryName causes the collection to be cleared.

Provides indexed access to directory entries in the collection.

property Items [AIndex: Integer]: TIdFTPListItem;

Integer position in the collection to be accessed.

Items is an indexed TIdFTPListItem property that provides access to TIdFTPListItem objects contained in the collection using the index specified in AIndex. They are usually created by the TIdFTPList.LoadList method.

Indicates the directory listing format used when parsing in TIdFTPList.LoadList.

property ListFormat: TIdFTPListFormat;

ListFormat is a TIdFTPListFormat property that indicates the type of directory listing format that should be used when loading the directory listing with the LoadList method. ListFormat us ised in Parse to determine the appropriate parsing mechanism for directory entries in the collection.

ListFormat normally contains the the value returned by the TIdFTPList.CheckListFormat method.

The default value for ListFormat is flfUnix, as assigned in the Create constructor.

Creates a new directory listing entry and adds it to the collection.

function Add: TIdFTPListItem;

TIdFTPListItem - The new directory list item that was created.

Add is a TIdFTPListItem function that creates a new entry for a formatted directory listing, and adds the object instance to the Items in the collection.

Determines the appropriate directory list type.

function CheckListFormat(Data: string; const ADetails: Boolean = False): TIdFTPListFormat; virtual;

Directory list data

TIdFTPListFormat - The appropriate directory listing format type.

CheckListFormat is a TIdFTPListFormat function that determines the appropriate directory list type to be used in the LoadList and Parse methods. CheckListFormat is called when TIdFTP needs to load and parses a directory listing returned from the FTP server. To use this with the LoadList, you need to set the ListFormat property to the return value.

Constructor for the object instance.

constructor Create; overload;

Create is the constructor for the object instance. Create calls the inherited constructor using TIdFTPListItem as the ItemClass for the collection. Create also sets the default value for the ListFormat property to flfUnix.

Returns the position of a directory entry in the collection.

function IndexOf(AItem: TIdFTPListItem): Integer;

Directory entry to be located in the collection.

Integer - Position of the item in the collection.

IndexOf is an Integer function that returns the integer position of the directory entry specified in AItem in the Items for the collection. IndexOf will return a value in the range 0 to Count - 1, or -1 when Items does not contain a directory entry item that matches AItem.

Loads the Directory listing from a TStrings and parses it based on the value of TIdFTPList.ListFormat.

procedure LoadList(AData: TStrings);

The directory listing data to be parsed into the TIdFTPList.

LoadList is a procedure used to load the Directory listing from the TStrings variable AData, and parses directory entries based on the value in TIdFTPList.ListFormat. LoadList will create individual TIdFTPListItem objects, and call the TIdFTPList.Parse method.

Parses data for a directory entry using the specified ListFormat.

procedure Parse(ListFormat: TIdFTPListFormat; AItem: TIdFTPListItem);

The list item format

The item that is to be parsed.

This parses the data located in the AItem.Data using the specified layout in in the ListFormat parameter.

This procedure triggers the IdFTPList.OnParseCustomListFormat event.

procedure ParseCustom(AItem: TIdFTPListItem); virtual;

The item that is to be parsed.

This procedure triggers the TIdFTPList.OnParseCustomListFormat event. This event is used to provide custom parsing code. This is sometimes required if a developer needs to support some unusual directory listing formats.

If no TIdFTPList.OnParseCustomListFormat event is provided, an EIdInvalidFTPListingFormat exception is raised.

This procedure raises an EIdInvalidFTPListingFormat exception.

procedure ParseUnknown(AItem: TIdFTPListItem);

The item that is to be parsed.

This procedure raises an EIdInvalidFTPListingFormat exception. This is done if the ListFormat property is set to flfUnknown.

Gets the text representation of an item in a custom directory listing.

property OnGetCustomListFormat: TIdOnGetCustomListFormat;

OnGetCustomListFormat is a TIdOnGetCustomListFormat property that represents the event handler signalled when a TIdFTPListItems collection needs to access the text representation of a custom list format for the contents of an FTP listing. The application may assign a procedure to the event handler to allow creation of a custom directory listing when TIdFTPListItems.ListFormat contains the value flfCustom.

Event triggered when custom FTP parsing is desired.

property OnParseCustomListFormat: TIdOnParseCustomListFormat;

The TIdFTPListItem object that you parse. You parse the Data property and set the other properties as appropriately.

The object that triggered the event

OnParseCustomListFormat is an event handler triggered by the TIdFTPList.ParseCustom method, and is normally triggered when the TIdFTPList.ListFormat property contains flfCustom.