NewSequenceFile Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.NewSequenceFile

Return Value

SequenceFile

Purpose

Creates and returns a new SequenceFile object.

Remarks

Call the Engine.ReleaseSequenceFileEx method on this object before you release it.

This method stores the new sequence file in the internal cache of the engine and adds a load reference to the sequence file. TestStand uses the load reference count to determine when to unload the sequence file from the internal cache of the engine. In addition to this method, the SequenceFile.AddLoadReference and Engine.GetSequenceFileEx methods add a load reference to the sequence file. The Engine.ReleaseSequenceFileEx method removes a load reference.

You must call Engine.ReleaseSequenceFileEx for each load reference you add to the sequence file. When you release the last load reference, TestStand unloads the file from the internal cache of the engine. While unloading the file from the internal cache of the engine, TestStand executes the SequenceFileUnload callback sequence, if applicable.


See Also

Engine.GetSequenceFileEx

Engine.NewPropertyObjectFile

Engine.ReleaseSequenceFileEx

SequenceFile

SequenceFile.AddLoadReference

SequenceFile.Save

WAS THIS ARTICLE HELPFUL?

Not Helpful