poIResultCtrl UnloadResult
Clears and unloads data for the specified result definition.
Syntax
poIResultCtrl_handle UnloadResult id context notify
Application
HyperView Tcl Modify
Description
This command, valid only in HyperView - MultiCore profile, clears and unloads data for the specified result definition. Returns Success (0) if unloading was successful or Warning (2) if there was a problem unloading the result data.
Inputs
- id
- The ID of the result definition to unload.
- 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 unload 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 UnloadResult 4 scalar true
hwi CloseStack
Errors
Returns error code if there was an error in unloading and sets error condition on the session handle. See session_handle GetError.
Related Topics
See the HyperView - MultiCore APIs topic for additional information regarding the various Tcl/Tk commands that have been added for this workflow.