ReleaseSequenceFileEx Method

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Syntax

Engine.ReleaseSequenceFileEx ( sequenceFileToRelease, options = 0)

Return Value

Boolean

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 sequence for the SequenceFile object.

Refer to SequenceFile.CanUnload for more information about loading and unloading files in the cache.

Purpose

Releases the SequenceFile object from the internal cache of the engine.

Remarks

Call this method to release the sequence file you obtained from the Engine.NewSequenceFile or Engine.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 internal cache of the engine.

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, if applicable.

If this method generates an error, TestStand does not release the object from the internal cache of the engine. If your development environment requires you to explicitly release COM references, only release the COM 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 the ActiveX reference to the sequence file.

Parameters

sequenceFileToRelease As SequenceFile

[In] Specifies a reference to the sequence file to release.

options As Long

[In] Specify one or more ReleaseSeqFileOptions constants. Use the bitwise-OR operator to specify multiple sequence file flags.

This parameter has a default value of 0.


See Also

Engine.GetSequenceFileEx

Engine.NewSequenceFile

ReleaseSeqFileOptions

SequenceFile

SequenceFile.AddLoadReference

SequenceFile.CanUnload

SequenceFile.IsExecuting

WAS THIS ARTICLE HELPFUL?

Not Helpful