NewEditContext Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.NewEditContext ( obj, [editArgsParam], [locationString])

Return Value

SequenceContext

A reference to a SequenceContext object. Release this reference when you are finished using it.

Purpose

Returns a SequenceContext object that approximates the sequence context TestStand creates when you run a sequence.

Remarks

You can pass the object this method returns as a parameter to the Engine.DisplayBrowseExprDialogEx and Engine.DisplayBrowsePropertyObjectDialog methods.

When you pass an array of step references, this method returns a context with a Step property that represents multiple steps, where the subproperties of Step contain only properties common to all steps in the array. Use the context with SequenceContext.GetMultipleValues to determine whether an element of the property, such as the value, comment, format, or flags, represents the shared element value for all the steps in the array. If at least one step has a different value for an element, the property element in the context contains a default value.

Parameters

obj As PropertyObject

[In] Specifies the object to initialize the sequence context. You can pass a sequence file, sequence, step, variable, or array of object references to steps. This method sets the sequence context properties that correspond to the object you pass.

editArgsParam As Variant

[In] [Optional] Specifies an EditArgs object that indicates which items are currently selected in the user interface.

locationString As Variant

[Out] [Optional] Returns the lookupString for the object passed in. Use this lookupString to access the object from the sequence context.


See Also

Engine.DisplayBrowseExprDialogEx

Engine.DisplayBrowsePropertyObjectDialog

EditArgs

Omitting Optional Parameters

PropertyObject

SequenceContext

SequenceContext.GetMultipleValues

SequenceFile.NewEditContext

Step

WAS THIS ARTICLE HELPFUL?

Not Helpful