poIPost CancelLoading

Cancels all loading operations that are in progress.

Syntax

poIPost_handle CancelLoading notify

Application

HyperView Tcl Modify

Description

This command, valid only in Upfront Data Loading Mode, cancels all loading operations that are currently in progress. This includes both simulation step and result loading operations. Returns Success (0) if cancelling was successful or Warning (2) if there was a problem during cancelling.

Inputs

notify
Set to 'true' to trigger an event to update the browser, otherwise 'false'. The default value is true.

Example

To cancel all loading operations on the current window:
hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client CancelLoading true
hwi CloseStack

Errors

Returns an error code and sets error condition on the session handle. See session_handle GetError.

Related Topics

See the Upfront Data Loader APIs topic for additional information regarding the various Tcl/Tk commands that have been added for this workflow.