TCDVcsEnumLockedFiles
Return to Introduction  Previous page  Next page
Enumerates through the list of Files locked by the user identified by UserID.

Delphi (TCDirectIntf.pas)

type  
  TEnumLockedFiles = function ( Data: Pointer; Name, LockPath: String; ID, ParentID, LockedRevID: Cardinal; Modified, RevisionCount, Status: Integer ): Boolean;  
 
function VcsEnumLockedFiles( UserID: Cardinal; EnumProc: TEnumLockedFiles; Data: Pointer ): Integer;  

Parameters

Name
Description
UserID
The ID of the User to retrieve the locked file list for. Currently the only valid value is 0 which is the currently logged in user.
EnumProc
The procedure (prototype TEnumLockedFiles) that will be called for each File 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

TEnumLockedFiles is the prototype of the procedure that is called by VcsEnumLockedFiles. 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
LockPath
The full path to the local location of the locked file. I.e. where the file was checked out to.
ID
The unique ID used to identify this file
ParentID
The unique ID of the parent Folder
LockedRevID
The ID of the revision that is locked
Modified
The date this file was last modified (FileDate)
RevisionCount
The number of revisions contained by this file
Status
The current status of the local file



Exported

type  
  TIntEnumLockedFiles = function ( Context, Data: Pointer; pName, pLockPath: PChar; ID, ParentID, LockedRevID: Cardinal; Modified, RevisionCount, Status: Integer ): Boolean; stdcall;  
 
function TCDVcsEnumLockedFiles( UserID: Cardinal; Context, Data: Pointer; EnumProc: TIntEnumLockedFiles ): Integer; stdcall;  


 


© 1995-2018 MCN Software