poIResultCtrl CancelResult

Cancels any pending tasks associated with a result definition.


poIResultCtrl_handle CancelResult id context notify


HyperView Tcl Modify


This command, valid only in Upfront Data Loading Mode, cancels all future tasks, clears and unloads the specified result definition. Returns Success (0) if cancelling was successful or Warning (2) if there was a problem cancelling.


The ID of the result definition to cancel.
A string indicating the context of the request. Valid values are: scalar, tensor, vector, and iso.
Set to 'true' to trigger an event to update the browser, otherwise 'false'. The default value is true.


To cancel loading the scalar result with ID 4:

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 CancelResult 4 scalar true
hwi CloseStack


Returns error code if there was an error in cancelling 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.