TCDVcsEnumFolders

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

Delphi (TCDirectIntf.pas)

type

TEnumFolders = function ( Data: Pointer; Name, TCPath, LocalFolder: String; ID, ParentID: Cardinal; FolderCount, FileCount: Integer ): Boolean;

function VcsEnumFolders( RootID: Cardinal; EnumProc: TEnumFolders; Data: Pointer; Recursive: Boolean ): Integer;

Parameters

Name	Description
RootID	The ID of the Project or Folder 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.
Recursive	If this is True, the enumeration will include all subfolders. If False, only the immediate child folders of the object pointed to by RootID will be enumerated.

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 VcsEnumFolders. 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
TCPath	The full name of the folder as used by Team Coherence. e.g. //Project/Source/Units
LocalFolder	The local directory used as the default working directory for the current user.
ID	The unique ID used to identify this Folder
ParentID	The unique ID of the parent Folder or Project
FolderCount	The number of subfolders this Folder contains
FileCount	The number of Files directly contained by this Folder.

Note that the enumeration only includes objects that are in the current View, and also excludes objects that have been removed and are in the recycle bin.

Exported

type

TIntEnumFolders = function ( Context, Data: Pointer; pName, pTCPath, pLocalFolder: PChar; ID, ParentID: Cardinal; FolderCount, FileCount: Integer ): Boolean; stdcall;

function TCDVcsEnumFolders( RootID: Cardinal; Context, Data: Pointer; EnumProc: TIntEnumFolders; Recursive: Boolean ): Integer; stdcall;