poIPost GetResultStatus

Syntax

post_handle GetResultStatus id context

Application

HyperView Tcl Query

Description

This command, valid only in Upfront Data Loading Mode, returns the load status for the given result definition ID. Returns one of the following:

"Unloaded" - Result is not yet loaded.
"Loading" - Result is in the process of loading.
"Loaded" - Result has been fully loaded.
"Partial" - Result has finished loading but is only partially loaded.
"Error" - There was an error when trying to load the result.

Inputs

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

Example

To get the current status of the scalar result 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 GetResultStatus 5 scalar
hwi CloseStack

Errors

Returns "Invalid" if there was an error retrieving the load status for the given ID and context. Returns "" if there was another error and sets an error condition on the session handle. See session_handle GetError.