VcsAfterCheckIn
Return to Introduction  Previous page  Next page
If this method is exported from the DLL, it will be called after a Check In occurs:

VcsAfterCheckIn

procedure VcsAfterCheckIn( pProject, pFolder, pObjectName, pUserName, pComments, pNewRevision: PChar;   
                           Branched: Boolean; TimeStamp, FileDate, Flags: Integer;   
                           UserID, FileID: Cardinal ); stdcall; export;  

This procedure is called after a CheckIn 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 checked in
pUserName
The name of the user that carried out the action
pComments
The comments assigned to the new revision
pNewRevision
The name of the newly created revision
Branched
Indicates whether the checkin caused a branch revision to be created
Timestamp
The date/time that the file was checked in
FileDate
The date/time that the local file was last modified
Flags
The flags used for the checkin action. See TCVcsConst.pas
UserID
The ID of the user that carried out the action.
FileID
The ID of the file that was checked in



Example (Delphi)

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

procedure VcsAfterCheckIn( pProject, pFolder, pObjectName, pUserName, pComments, pNewRevision: PChar;   
                           Branched: Boolean; TimeStamp, FileDate, Flags: Integer;   
                           UserID, FileID: Cardinal );  
var  
  Name, FullName, EMail, Location, Extra: String;  
begin  
  // This method is called after a successful Check In.  
  DoGetUserInfo( UserID, Name, FullName, EMail, Location, Extra );  
  LogIt( Format( '%s - ''%s (%s)'' Checked In file ''%s'' - Comments: %s',   
                 [ DateTimeToStr( FileDateToDateTime( TimeStamp ) ),   
                 String( pUserName ), EMail, String( pObjectName ),   
                 String( pComments ) ] ) );  
end;  
 


 


© 1995-2018 MCN Software