Error

 

Description

Raises a critical error during execution if two string values are equal.

 

Arguments

1.Error - Name of the Macro.

2.Match - A value indicating if the comparison made will be an equality or inequality comparison.  The values Yes, No, True, False, Matched, and Unmatched or the first character of these words is acceptable.

3.Expression 1 - The value to compare and in the event that a match is not made will be returned from the function by default.

4.Expression 2 - The value to compare against.

5.Message - The error message to throw if expression 1 and expression 2 match.

6.Replacement Value - Optional value to return in place of expression 1 if there is no match.

 

Examples

<Error|Match|<Parameter|Test>|X|Parameter Test cannot be X.>

If the value of <Parameter|Test> matches X the error "Parameter Test cannot be X." occurs.

If the value of <Parameter|Test> does not match X the value of <Parameter|Test> is returned.

 

<Error|Match|<Parameter|Test>|X|Parameter Test cannot be X.|Z>

If the value of <Parameter|Test> matches X the error "Parameter Test cannot be X." occurs.

If the value of <Parameter|Test> does not match X the value Z is returned.

 

<Error|Unmatched|<Parameter|Test>|X|Parameter Test can only be X.>

If the value of <Parameter|Test> matches X the value of <Parameter|Test> is returned.

If the value of <Parameter|Test> does not match X the error "Parameter Test can only be X." occurs.

 

<Error|Unmatched|<Parameter|Test>|X|Parameter Test can only be X.|Z>

If the value of <Parameter|Test> matches X the value Z is returned.

If the value of <Parameter|Test> does not match X the error, "Parameter Test can only be X." occurs.

 

Notes

If an error is produced it will cause the job step to fail.

 

Copyright © 2024 pasUNITY, Inc.

 

Send comments on this topic.

Created with an evaluation copy of HelpSmith.
To remove this notice, you should purchase the full version of the product.