TCDTrkEnumFolders

Enumerates through the list of Folders that are children of the passed RootID and calls the passed function.

Delphi (TrkIntf.pas)

type

TEnumFolders = function ( Data: Pointer; Name: String; ID: Cardinal; Intray: Boolean ): Boolean;

function TrkEnumFolders( RootID: Cardinal; EnumProc: TEnumFolders; Data: Pointer ): Integer;

Parameters

Name	Description
RootID	The ID of the Project that the enumeration starts from.
EnumProc	The procedure (prototype TEnumFolders) that will be called for each Folder found.
Data	Pointer to additional information that can be passed to the EnumProc in the Data parameter.

Return Value

Err_OK if successful or an error code indicating the error.

Remarks

TEnumFolders is the prototype of the procedure that is called by TrkEnumFolders. This function should return True to continue enumerating the folders, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each Folder:

Name	Description
Data	The Data parameter as passed into the enumerator. Can be nil
Name	Name of the Folder
ID	The unique ID used to identify this Folder
Intray	Returns True if the folder is an Intray

Note that, since Folders are user specific, only the folders defined by the User you connected as will be enumerated..

Exported

type

TIntEnumFolders = function ( Context, Data: Pointer; pName: PChar; ID: Cardinal; Intray: Boolean ): Boolean; stdcall;

function TCDTrkEnumFolders( RootID: Cardinal; Context, Data: Pointer; EnumProc: TIntEnumFolders ): Integer; stdcall;