Delphi (TCDirectIntf.pas)
type
|
TEnumFiles = function ( Data: Pointer; Name, LocalPath, LockedBy: String; ID, ParentID, AncestorID: Cardinal; Modified, Timestamp, CompressedSize, RevisionCount, ShareCount, Status: Integer; IsVirtual, Frozen: Boolean ): Boolean;
|
|
function VcsEnumFiles( RootID: Cardinal; EnumProc: TEnumFiles; 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 TEnumFiles) that will be called for each File 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 files contained in subfolders. If False, only the files contained directly by RootID will be enumerated.
|
Return Value
Err_OK if successful or an error code indicating the error.
Remarks
TEnumFiles is the prototype of the procedure that is called by VcsEnumFiles. This function should return True to continue enumerating the files, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each File:
Name
|
Description
|
Data
|
The Data parameter as passed into the enumerator. Can be nil
|
Name
|
Name of the file
|
LocalPath
|
The full path to the local copy of the file
|
LockedBy
|
Comma-separated list of users holding a lock on this file.
|
ID
|
The unique ID used to identify this file
|
ParentID
|
The unique ID of the parent Folder
|
AncestorID
|
If this is a shared file, indicates the ID of the shared file.
|
Modified
|
The date this file was last modified (FileDate)
|
Timestamp
|
The timestamp of the tip revision. E.g. last checkin
|
CompressedSize
|
The size, in bytes, of the tip revision
|
RevisionCount
|
The number of revisions contained by this file
|
ShareCount
|
If this is the root of a share, indicates the number of files dependent on this one.
|
Status
|
The current status of the local file
|
IsVirtual
|
True if this is a virtual file
|
Frozen
|
True if development has been halted on this file
|
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
|
TIntEnumFiles = function ( Context, Data: Pointer; pName, pLocalPath, pLockedBy: PChar; ID, ParentID, AncestorID: Cardinal; Modified, Timestamp, CompressedSize, RevisionCount, ShareCount, Status: Integer; IsVirtual, Frozen: Boolean ): Boolean; stdcall;
|
|
function TCDVcsEnumFiles( RootID: Cardinal; Context, Data: Pointer; EnumProc: TIntEnumFiles; Recursive: Boolean ): Integer; stdcall;
|
© 1995-2018 MCN Software