void exception.SetFailure(string)

Return Type: void
Parameters: string FailMessage

Description:
SetFailure sets the state of the exception to a failure and defines the message of the exception as FailMessage. Falures that are thrown will exit a script if not processed in a try-catch statement.

Example Code

exception fail; fail.SetFailure("User Failure"); fail.throw();

Output

** FAILURE: from 'Sample.psc' on line 4 - User Failure

See exception for additional examples.

See Also: exception