poIResultCtrl CancelResult

Syntax

poIResultCtrl_handle CancelResult id context notify

Application

HyperView Tcl Modify

Description

This command, valid only in HyperView - MultiCore profile, 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.

Inputs

id: The ID of the result definition to cancel.

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

Example

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

Errors

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