BeforeAction |
Action : <TAction> |
The instance of the current action. Allows ac=
cess to the action properties and methods. All properties are set to =
the values provided by the action editor or their defaults. |
SkipAction : Boolean |
An out parameter which allows for the action to =
be skipped during a build. Default is false. |
|
Called before the action is exe=
cuted. When called all properties on the action have been initialised =
to those provided in the action editor dialog. Properties which have not be=
en provided are set to their defaults. Use this event to change anyth=
ing about the action or perform operations which need to occur before the a=
ction is run. Also this event can be used to skip an action entirely. If th=
e action is skipped it will report as such in the log, and no more processi=
ng of the action or its scripts will occur. Run-time errors in this s=
cript will stop the action from running and the action will report as faile=
d. |
AfterAction |
Action : <TAction> |
The instance of the current action. Allows ac=
cess to the action properties and methods. All properties are set to =
the values used during the run of the action. |
ActionResult : boolean |
Indicates if the action succeeded or failed. All=
ows for the handling or overriding of the actions status during a build.
|
Continue : boolean |
Indicates if the build should continue after =
this action has completed or not. Return false to stop the build, ret=
urn true to ignore the build result and continue the build. Default is =
unset. |
|
Called after the action has exe=
cuted. All properties on the action will be the same as when the action was=
run. Any properties which change during the run will be available at this =
point (e.g. Exit codes properties). This event allows for the handlin=
g of action error states that where are not directly handled by the action =
itself. For example if an certain error code is acceptable it can be logged=
and ignored through this event. Conversely a certain successful run =
condition that is not desirable could be reported through this event. To ac=
hieve these outcomes set the ActionResult and Continue parameters to values=
which reflect the true outcome of the actions run. Run-time errors p=
roduced by this script will cause the action to report as failed. Setting o=
f either the ActionResult or Continue parameters will not override this. |
OnStatusMessage |
Action : <TAction> |
The instance of the current action. Allows ac=
cess to the action properties and methods. All properties are set to =
values used during the run of the action. |
StatusMessage : TStatusMessage |
The status message object contains all informati=
on relating to the message being logged (Lines, MessageText, MessageTitle, =
and Progress). |
|
Called whenever the action gene=
rates a log message. Actions will generate this event when the action=
has received output from the underlying tool, or when the action itself ha=
s something to report. The StatusMessage may contain zero-to-many lines of =
text and is in the format directly seen in the log. As formatting dep=
ends on the tool being used we advise using the RegExp function to parse th=
e output if required. Also please review the TString object=
type for more information on how to access the contents of the messages.=
p> Run-time errors produced by this script will cause the action to repor=
t as failed. |