OnError Element (MSBuild)

Article
12/06/2011

Causes one or more targets to execute, if the ContinueOnError attribute is false for a failed task.

<OnError ExecuteTargets="TargetName"
    Condition="'String A'=='String B'" />

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
Condition	Optional attribute. Condition to be evaluated. For more information, see MSBuild Conditions.
ExecuteTargets	Required attribute. The targets to execute if a task fails. Separate multiple targets with semicolons. Multiple targets are executed in the order specified.

Condition

Optional attribute.

Condition to be evaluated. For more information, see MSBuild Conditions.

ExecuteTargets

Required attribute.

The targets to execute if a task fails. Separate multiple targets with semicolons. Multiple targets are executed in the order specified.

Child Elements

None.

Parent Elements

Element	Description
Target	Container element for MSBuild tasks.

Remarks

MSBuild executes the OnError element if one of the Target element's tasks fails with the ContinueOnError attribute set to false. When the task fails, the targets specified in the ExecuteTargets attribute is executed. If there is more than one OnError element in the target, the OnError elements are executed sequentially when the task fails. For more information, see MSBuild Targets.

Example

The following code executes the TaskOne and TaskTwo tasks. If TaskOne fails, MSBuild evaluates the OnError element and executes the OtherTarget target.

<Target Name="ThisTarget">
    <TaskOne ContinueOnError="false">
    </TaskOne>
    <TaskTwo>
    </TaskTwo>
    <OnError ExecuteTargets="OtherTarget" />
</Target>

Share via