Cancel Method (PIAsynchStatus Object)

                    

The Cancel method is used to terminate long running calls when complete results are no longer desired.

Syntax

object.Cancel

The Cancel method syntax has these parts:

Part Description
object An object expression that evaluates to a PIAsynchStatus object.

Remarks

Responsiveness of the call depends on the granularity of the internal call placed to the server.  For example an internal call to retrieve message from the message log may fetch 1000 messages at a time.  The cancel can only occur between fetches.  There is a trade off between a fine granularity for canceling and overall performance.

Trappable Errors

In addition to generic errors (such as Out of Memory), the following errors may occur:

Error Description
pseFAIL

Call has already completed.

pseINVALIDARG

Call is not yet in progress, or call is in the process of being canceled already.

Enabling Operational Intelligence