poIResultCtrl GetActiveResult

Gets the ID of the currently plotted result definition of the specified type.

Syntax

poIResultCtrl_handle GetActiveResult context

Application

HyperView Tcl Query

Description

This command, valid only in Upfront Data Loading Mode, returns the ID of the currently plotted result definition of the specified type. If there is no plot matching the specified type, then 0 is returned.

Inputs

context
A string indicating the context of the request. Valid values are: scalar, tensor, vector, and iso.

Example

To get the active vector ID:

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 GetActiveResult vector
hwi CloseStack

Errors

None.

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.