B.15 FailTask
Prev | Appendix B. Core tasks | Next

## B.15 FailTask

Causes the current build script execution to fail and the script to exit with an (optional) error message.

Table B.17: Attributes

Name | Type | Description | Default | Required
--- | --- | --- | --- | ---
`message` | `String` | The message to display (reason for script abort). | "No Message" | No
`msg` | `String` | Alias for message | "No Message" | No
`if` | `String` | Name of property that must be set for script to exit. | n/a | No
`unless` | `String` | Name of property that must `not` be set in order for script to exit. | n/a | No

### B.15.1 Examples

    <!-- Exit w/ message -->
    <fail message="Failed for some reason!" />

    <!--  Exit if ${errorprop} is defined -->
    <fail if="errorprop" message="Detected error!" />

    <!-- Exit unless ${dontfail} prop is defined. -->
    <fail unless="dontfail" message="Detected error!" />

Prev | Up | Next
B.14 ExecTask | Home | B.16 ForeachTask