Syntax

SequenceFile.AddLoadReference

Purpose

Adds a load reference that keeps the file in the internal cache of the engine.

Remarks

Call this method to add an additional 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 Engine.GetSequenceFileEx and Engine.NewSequenceFile methods also add a load reference to the sequence file. The Engine.ReleaseSequenceFileEx method removes a load reference.

You must call the Engine.ReleaseSequenceFileEx method 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, TestStand executes the SequenceFileUnload callback sequence, if applicable.

This method generates an error if the sequence file does not have any load references initially.

See Also

Engine.GetSequenceFileEx

Engine.NewSequenceFile

Engine.ReleaseSequenceFileEx