Cancel – PB Docs 2017

Description

Stops the execution of a pipeline object.

Applies to

Pipeline objects

Syntax

Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs.

Usage

Call this function only when Start or Repair is executing.

When you stop a pipeline with Cancel, data is committed as if the
pipeline had reached the maximum errors limit. You control how the
pipeline behaves when it reaches the limit in the Data Pipeline painter
(see the Working with Data Pipelines in Users Guide).

Examples

This statement for a CommandButton’s Clicked script allows the user
to stop the execution of the pipeline i_pipe:

See also

Repair

Start