VcsAfterLock
Return to Introduction  Previous page  Next page
If this method is exported from the DLL, it will be called after a Lock occurs. Note that this event occurs as a result of the user using the Lock commands and is not triggered after a CheckOut action.

VcsAfterLock

procedure VcsAfterLock( pProject, pFolder, pObjectName, pUserName, pLockComments, pRevision: PChar;   
                        TimeStamp: Integer; UserID, FileID: Cardinal ); stdcall; export;  

This procedure is called after a Lock action occurs. This is a notification event only and none of the values passed in can be modified.

Parameters

Name
Description
pProject
The name of the Project containing the file
pFolder
The name of the Folder containing the file
pObjectName
The name of the file object that was Locked
pUserName
The name of the user that carried out the action
pLockComments
The comments assigned to the lock
pRevision
The name of the revision being locked
Timestamp
The date/time of the revision being locked
UserID
The ID of the user that carried out the action.
FileID
The ID of the file that was locked



Example (Delphi)

The following method is called after a file is locked and simply logs the action to a local text file:

procedure VcsAfterLock( pProject, pFolder, pObjectName, pUserName, pLockComments, pRevision: PChar;   
                        TimeStamp: Integer; UserID, FileID: Cardinal );  
begin  
  // This method is called after a successful Lock. This does not include files locked during Check Out.  
  LogIt( Format( '%s - ''%s'' Locked revision ''%s'' of ''%s''',   
                 [ DateTimeToStr( FileDateToDateTime( TimeStamp ) ),   
                 String( pUserName ), String( pRevision ),   
                 String( pObjectName ) ] ) );  
end;  
 

 


© 1995-2018 MCN Software