GetSequenceFile Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

SequenceAdapter.GetSequenceFile ( path)

Return Value

SequenceFile

Returns a reference to a SequenceFile object that represents the sequence file the path parameter specifies. The returned reference is null if the path parameter is invalid or does not specify a valid sequence file.

Purpose

Returns a reference to a SequenceFile object for examining the contents of the file.

Remarks

Use this method to examine the contents of a sequence file without running load and unload callbacks, without preloading modules, and without merging types. Sequence files loaded by this method remain in memory until they have not been referenced after several minutes. As a result, calling this method multiple times for the same file does not usually cause the file to be loaded multiple times.

Do not call Engine.ReleaseSequenceFileEx on this object before releasing it.

To execute or edit a sequence file, use the Engine.GetSequenceFileEx method instead of this method.

Parameters

path As String

[In] Specifies the absolute pathname of the sequence file.


See Also

Engine.GetSequenceFileEx

Engine.ReleaseSequenceFileEx

SequenceFile

WAS THIS ARTICLE HELPFUL?

Not Helpful