Stops the execution of a pipeline object.
Pipeline objects
pipelineobject.Cancel ( )
Argument |
Description |
|---|---|
pipelineobject |
The name of a pipeline user object that contains the pipeline object to be executed |
Integer. Returns 1 if it succeeds and -1 if an error occurs.
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 PowerBuilder Users Guide).
This statement for a CommandButton’s Clicked script allows the user to stop the execution of the pipeline i_pipe:
i_pipe.Cancel()
