TCDVcsEnumRevisions
Return to Introduction  Previous page  Next page
Enumerates through the list of Revisions contained by the file identified by FileID and calls the passed function.

Delphi (TCDirectIntf.pas)

type  
  TEnumRevisions = function ( Data: Pointer; Name, Author, Comments, LockedBy: String; ID, ParentID: Cardinal; Modified, Timestamp, CompressedSize, OriginalSize, CRC, VerCount, PromoCount: Integer ): Boolean;  
 
function VcsEnumRevisions( FileID: Cardinal; EnumProc: TEnumRevisions; Data: Pointer ): Integer;  
 
Parameters

Name
Description
FileID
The ID of the file that contains the revisions.
EnumProc
The procedure (prototype TEnumRevisions) 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

TEnumRevisions is the prototype of the procedure that is called by VcsEnumRevisions. This function should return True to continue enumerating the revisions, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each Revision:

Name
Description
Data
The Data parameter as passed into the enumerator. Can be nil
Name
Name of the revision
Author
The author of this revision
Comments
The comments assigned when this revision was created.
LockedBy
Comma-separated list of users holding a lock on this revision.
ID
The unique ID of the Revision
ParentID
The ID of the file containing this revision.
Modified
The date this revision was last modified (FileDate)
Timestamp
The timestamp of the revision.
CompressedSize
The size, in bytes, of the data contained by the revision
OriginalSize
The original size of the files contained by this revision
CRC
The CRC value used to determine whether changes have been made to a file before it is checked in.
VerCount
The number of Version Labels attached to this revision
PromoCount
The number of Promotion Labels attached to this revision


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  
  TIntEnumRevisions = function ( Context, Data: Pointer; pName, pAuthor, pComments, pLockedBy: PChar; ID, ParentID: Cardinal; Modified, Timestamp, CompressedSize, OriginalSize, CRC, VerCount, PromoCount: Integer ): Boolean; stdcall;  
 
function TCDVcsEnumRevisions( FileID: Cardinal; Context, Data: Pointer; EnumProc: TIntEnumRevisions ): Integer; stdcall;  
 


 


© 1995-2018 MCN Software