poIPost GetResultPlotted

Gets the plot status for the given result definition ID.

Syntax

post_handle GetResultPlotted id context

Application

HyperView Tcl Query

Description

This command, valid only in Upfront Data Loading Mode, returns the plot status for the given result definition ID. Returns true if the result is plotted, false if it is not plotted.

Inputs

id
The result definition ID.
context
A string indicating the context of the result to get the plot status for (scalar, tensor, vector, iso).

Example

To get the current status of the scalar definition with ID 5:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetResultPlotted 5 scalar
hwi CloseStack

Errors

Returns false and sets an 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.