GetSequenceFileEx 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.GetSequenceFileEx ( seqFilePath, getSeqFileFlags = GetSeqFile_OperatorInterfaceFlags, handlerType = ConflictHandler_Error)

Return Value

SequenceFile

A SequenceFile object.

Purpose

Returns the SequenceFile object for the sequence file the sequenceFilePath parameter specifies.

Remarks

Loads the sequence file from disk, if necessary. Call the Engine.ReleaseSequenceFileEx method on this object before releasing it.

This method loads the sequence file into 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.NewSequenceFile methods 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. While unloading the file from the cache, TestStand executes the SequenceFileUnload callback sequence, if applicable.

You can use the SequenceAdapter.GetSequenceFile method to examine the contents of a sequence file without running load and unload callbacks, without preloading modules, and without merging types.

You can use the GetSeqFile_GetFileOnlyIfInCache option with this method to determine whether a sequence file is already loaded in the engine internal cache.

Parameters

seqFilePath As String

[In] Specifies the pathname of the sequence file. If the pathname is relative, this method tries to find it in the current directory, unless you specify the GetSeqFile_FindFile option.

getSeqFileFlags As Long

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

This parameter has a default value of GetSeqFile_OperatorInterfaceFlags.

handlerType As TypeConflictHandlerTypes

[In] Specifies how to handle type conflicts.

This parameter has a default value of ConflictHandler_Error.


See Also

Engine.NewSequenceFile

Engine.ReleaseSequenceFileEx

GetSeqFileOptions

SequenceAdapter.GetSequenceFile

SequenceFile

SequenceFile.AddLoadReference

TypeConflictHandlerTypes

WAS THIS ARTICLE HELPFUL?

Not Helpful