VcsAfterPromote
Return to Introduction  Previous page  Next page
If this method is exported from the DLL, it will be called after a file is promoted.

VcsAfterPromote

procedure VcsAfterPromote( pProject, pFolder, pObjectName, pUserName, pRevision, pPromoteTo: PChar;   
                           UserID, FileID, PromotionID: Cardinal ); stdcall; export;  

This procedure is called after a Promote 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 Promoted
pUserName
The name of the user that carried out the action
pRevision
The name of the revision that was promoted
pPromoteTo
The Promotion Label that the file was promoted to
UserID
The ID of the user that carried out the action.
FileID
The ID of the file that was promoted
PromotionID
The ID of the Promotion Label that the file was promoted to



Example (Delphi)

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

procedure VcsAfterPromote( pProject, pFolder, pObjectName, pUserName, pRevision, pPromoteTo: PChar;   
                           UserID, FileID, PromotionID: Cardinal );  
var  
  Name, FullName, EMail, Location, Extra: String;  
begin  
  // This method is called after a file is successfully promoted.  
  GetUserInfo( UserID, Name, FullName, EMail, Location, Extra );  
  LogIt( Format( '%s - ''%s (%s)'' Promoted revision %s of file ''%s'' to ''%s''',   
                 [ DateTimeToStr( Now ), String( pUserName ), EMail,   
                 String( pRevision ), String( pObjectName ),   
                 String( pPromoteTo ) ] ) );  
end;  
 
 

 


© 1995-2018 MCN Software