TCDVcsEnumProjects
Return to Introduction  Previous page  Next page
Enumerates through the list of Projects in the current repository and calls the passed function.

Delphi (TCDirectIntf.pas)

type  
  TEnumProjects = function ( Data: Pointer; Name: String; ID: Cardinal ): Boolean;  
 
function VcsEnumProjects( EnumProc: TEnumProjects; Data: Pointer ): Integer;  

Parameters

Name
Description
EnumProc
The procedure (prototype TEnumProjects) that will be called for each Project in the repository.
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

TEnumProjects is the prototype of the procedure that is called by VcsEnumProjects. This function should return True to continue enumerating the projects, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each Project:

Name
Description
Data
The Data parameter as passed into the enumerator. Can be nil
Name
Name of the Project
ID
Unique ID used to identify the Project within the repository.


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  
  TIntEnumProjects = function ( Context, Data: Pointer; pName: PChar; ID: Cardinal ): Boolean; stdcall;  
 
function TCDVcsEnumProjects( Context, Data: Pointer; EnumProc: TIntEnumProjects ): Integer; stdcall;  

 


© 1995-2018 MCN Software