ApplyChangeSetFile

Description: Apply a named ChangeSet to an application layer.
Warning: This function should be used only by advanced programmers.
Returns: Object that will become Invalid on completion.
Usage: Script Only.
Function Groups: Configuration Management
Related to: DirectApply | GetAppInstance | GetLoadedAppInstance | GetOEMLayer
Format: Layer.ApplyChangeSetFile(User, Comment, FileName, pError, SuppressError, RSema, Superior)
Parameters:  
User
Required. The account name, to which the changes will be attributed.
Comment
Required. A comment to be applied to the revision.
FileName
Required. The full path to the ChangeSet file.
pError

Required. A pointer to a value in which the status of the operation will be stored as a numeric value. Defined error codes are as follows:

Code Meaning
0 Success / No errors
1 Unsupported file version
2 Checksum error
3 File truncated
SuppressError
Optional Boolean. Set to TRUE if the error dialogs are to be suppressed. Defaults to FALSE.
RSema
Optional repository semaphore.
Superior
Optional Boolean. Set to TRUE if the ChangeSet's changes should take precedence in the event of a conflict.
Comments: The act of applying a ChangeSet file may produce unexpected results. Use with caution.

The Layer object can be acquired using GetAppInstance, GetLoadedAppInstance or GetOEMLayer.

Examples:

none.