ReleaseSequenceFileEx Method
Syntax
Engine.ReleaseSequenceFileEx ( sequenceFileToRelease, options = 0)
Return Value
Returns True if the file was removed from the TestStand internal cache. Returns False if the file remained in the cache because it has multiple load references or if TestStand initiates the execution of the SequenceFileUnload callback for the SequenceFile object.
For more information about loading and unloading files in the cache, refer to SequenceFile.CanUnload.
Purpose
Releases the SequenceFile object from the engine's internal cache.
Remarks
Call this method to release the sequence file that you obtained from the NewSequenceFile or GetSequenceFileEx methods.
This method removes a load reference from the sequence file. TestStand uses the load reference count to determine when to unload the sequence file from the engine's internal cache.
When you release the last load reference, TestStand unloads the file from the engine's internal cache. While unloading the file from the engine's internal cache, TestStand executes the SequenceFileUnload callback, if applicable.
If this method generates an error, TestStand does not release the object from the engine's internal cache. Only release your reference to a SequenceFile object if this method succeeds.
Use the ReleaseSeqFile_DoNotRunUnloadCallback option to prevent the SequenceFileUnload callback from running if the callback exists and the load reference being released is the last load reference. TestStand executes the SequenceFileUnloadCallback after this method returns.
 | Note Calling this method does not release your ActiveX reference to the sequence file. |
Parameters
sequenceFileToRelease As SequenceFile
[In] Pass a reference to the sequence file to release.
options As long
[In] Pass one or more ReleaseSeqFileOptions constants. Use the bitwise-OR operator to specify multiple get sequence file flags.
This parameter has a default value of 0.