GetSequenceFileEx Method
Syntax
Engine.GetSequenceFileEx ( sequenceFilePath, getSeqFileFlags = GetSeqFile_OperatorInterfaceFlags, handlerType = ConflictHandler_Error)
Return Value
A SequenceFile object.
Purpose
Returns the SequenceFile object for the sequence file specified by the sequenceFilePath parameter.
Remarks
Loads the sequence file from disk, if necessary. Call ReleaseSequenceFileEx on this object before releasing it.
This method loads the sequence file into the engine's internal cache 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 engine's internal cache. In addition to this method, the SequenceFile.AddLoadReference and Engine.NewSequenceFile methods also 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 that you add to the sequence file. When you release the last load reference, TestStand unloads the file from the engine's internal cache. While unloading the file from the cache, TestStand executes the SequenceFileUnload callback, if applicable.
You can use SequenceAdapter.GetSequenceFile to examine the contents of a sequence file without running load and unload callbacks, without preloading modules, and without merging types.
Parameters
sequenceFilePath 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] Pass one or more GetSeqFileOptions constants. Use the bitwise-OR operator to specify multiple Get 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.