Cancel PowerScript function
Description
Stops the execution of a pipeline object.
Controls
Pipeline objects
Syntax
|
1 |
<span>pipelineobject</span>.<span>Cancel</span> ( ) |
|
Argument |
Description |
|---|---|
|
pipelineobject |
The name of a pipeline user object that |
Return Values
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 PowerBuilder Users Guide).
Examples
This statement for a CommandButton’s Clicked
script allows the user to stop the execution of the pipeline i_pipe:
|
1 |
i_pipe.<span>Cancel</span>() |
See Also
Document get from Powerbuilder help
Thank you for watching.
Subscribe
Login
0 Comments
Oldest