TCDVcsEnumLabels
Return to Introduction  Previous page  Next page
Enumerates through the list of Version Labels or Promotion Labels in the repository. Can also be used to enumerate the labels attached to a specific revision of a file.

Delphi (TCDirectIntf.pas)

type  
  TEnumLabels = function ( Data: Pointer; LabelType: Integer; Name, Comments: String; ID: Cardinal; Timestamp: Integer ): Boolean;  
 
function VcsEnumLabels( RootID, RevID: Cardinal; LabelType: Integer; EnumProc: TEnumLabels; Data: Pointer ): Integer;  
 
Parameters

Name
Description
RootID
Either an ID pointing to a Project, Folder, or a File, or Zero for all labels in the repository.
RevID
If RootID is the ID of a File this can be used to enumerate the labels attached to a specific revision.
LabelType
Type of Label to enumerate. Can be either lt_VersionLabel or lt_PromotionLabel
EnumProc
The procedure (prototype TEnumLabels) that will be called for each revision 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

TEnumLabels is the prototype of the procedure that is called by VcsEnumLabels. This function should return True to continue enumerating the labels, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each Label:

Name
Description
Data
The Data parameter as passed into the enumerator. Can be nil
LabelType
Either lt_VersionLabel or lt_PromotionLabel
Name
Name of the Label
Comments
Comments assigned to the label
ID
Unique ID used to identify the label
Timestamp
The time the label was last modified


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  
  TIntEnumLabels = function ( Context, Data: Pointer; LabelType: Integer; pName, pComments: PChar; ID: Cardinal; Timestamp: Integer ): Boolean; stdcall;  
 
function TCDVcsEnumLabels( RootID, RevID: Cardinal; LabelType: Integer; Context, Data: Pointer; EnumProc: TIntEnumLabels ): Integer; stdcall;  


 


© 1995-2018 MCN Software