poIScalarDefine SetEnvelopeTracingEntity

Sets the envelope tracing entity.

Syntax

poIScalarDefine_handle SetEnvelopeTracingEntity entity

Application

HyperView Tcl Modify

Description

This command, valid only in Upfront Data Loading Mode, sets the envelope tracing entity for the result definition.
Note: The result definition can only be modified if it is not cached.

Inputs

entity
The envelope tracing entity value. This value must be one of the following: "none", "simulation" or "subcase"

Example

To set the envelope tracing entity for a result definition:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetResultHandle sdefine 4 scalar
sdefine SetEnvelopeTracingEntity subcase
hwi CloseStack

Errors

Returns an error code if there was an error setting the envelope tracing entity and sets 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.