poIResultCtrl CancelLoading

Syntax

poIResultCtrl_handle CancelLoading notify

Application

HyperView Tcl Modify

Description

This command, valid only in Upfront Data Loading Mode, cancels all pending load tasks associated with this result control. 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 loading all data for the active model:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetModelHandle model [client GetActiveModel]
model GetResultCtrlHandle rc
rc CancelLoading true
hwi CloseStack

Errors

Returns an error code if there was an error in cancelling and sets error condition on the session handle. See session_handle GetError.