CommitEditedFiles
Description: | This function compiles and commits edited files if the compile succeeds. |
Returns: | Object (which becomes Invalid upon completion) |
Usage: | Script Only. |
Function Groups: | Configuration Management |
Related to: | EditFile | DirectApply |
Format: | LayerRoot\CommitEditedFiles(User, Comment, AlreadyHasLock[, ReloadOnFailure, pFail, RSema, SuppressAudit]) |
Parameters: |
User |
Required. The user performing work on the repository's working copy. |
Comment |
Required. Text that will be stores with the repository commit. |
AlreadyHasLock |
Required. Boolean indicating whether we already have a working copy lock. |
ReloadOnFailure |
Optional Boolean. If set TRUE, then if the files cannot be integrated into a running system, the files are reverted and no reloading of the reverted files is performed. If set FALSE, then the reverted files are reloaded. This can be set to false when you are sure that none of the changes being committed have been integrated into a running application. Defaults to TRUE. |
pFail |
Optional pointer to a Boolean. Set TRUE upon failure. |
RSema |
Optional repository semaphore. If provided, it is essential that you also have the working copy lock. |
SuppressAudit |
Optional Boolean. Set TRUE to suppress the audit the commit. This is typically done because you are guaranteed to do another commit before you give up the WC lock. Defaults to FALSE. |
Comments: |
This helper function manages the Working Copy files by applying a set of file changes indicated in prior EditFile calls. If the compile does not succeed, this function will revert the compilation changes. By the time this launched module terminates, the Modified dictionary is always emptied. This module launches a worker module into the Layer so that the operation is not interrupted by this module's caller being slain. |