OnCancelFinished

<< Click to Display Table of Contents >>

 

OnCancelFinished

OnCancelFinished(ActorID, Failed, FeedbackError, ScriptError, Aborted, Retries)

Event triggered when the Cancel method finishes, successfully or not.

Description of parameters

Name

Description

ActorID

Informs to a script the name of the user passed on the ActorID parameter of the Cancel method in the Command Unit. If omitted when calling that method, assumes Elipse Power Viewer's user logon, "Anonymous" if there is no user logged on, or "System" if this method's call started at the server

Failed

When set to True, indicates that a Command Action failed and this was informed by the Failed parameter of the script of the OnCancel event

FeedbackError

When set to True, indicates that a Command Action failed because the returned value could not be read in the specified time-out. This may occur because the returned Tag does not exist, a configuration error, or the value has a bad quality. For an incorrectly configured Tag, such as a syntax error, it is possible that FeedbackError parameter be immediate, that is, with no waiting time

ScriptError

When set to True, indicates that a Command Action failed because the script had an execution error at some point

Aborted

Indicates whether an Action failed because it was aborted, that is, if the Abort method was used

Retries

Indicates the number of the retry in which this Action was finished. A value of 0 (zero) indicates that this Action was finished without retries. If the value of this parameter is different from 0 (zero), this event is only executed after the last retry

Was this page useful?