ReleaseSeqFileOptions
- Updated2025-07-21
- 2 minute(s) read
ReleaseSeqFileOptions
These constants represent the options you can use with the options parameter of the Engine.ReleaseSequenceFileEx method. Use the bitwise-OR operator to specify more than one option.
- ReleaseSeqFile_DoNotRunUnloadCallback –(Value: 0x2) Use this option to prevent the SequenceFileUnload callback sequence from running if the callback exists and the reference being released is the last reference. If other references exist to the sequence file, TestStand might execute the SequenceFileUnload callback when these references are released using the Engine.ReleaseSequenceFileEx method. Regardless of whether you use this option, TestStand does not execute the SequenceFileUnload callback if the SequenceFileLoad callback was not executed because all references to the sequence file were obtained by passing the GetSeqFile_DoNotRunLoadCallback option to the Engine.GetSequenceFileEx method. Use the SequenceFile.UnloadCallbackEnabled property to prevent the SequenceFileUnload callback from ever being executed.
- ReleaseSeqFile_NoOptions –(Value: 0x0) No options.
- ReleaseSeqFile_UnloadFile –(Value: 0x4) Use this option to request TestStand to remove a sequence file from the internal cache of the engine. When you specify this option, it does not guarantee that TestStand removes the sequence file from the cache because there might be multiple references to it or it might be executing. If TestStand cannot remove a sequence file from the cache, the Engine.ReleaseSequenceFileEx method generates an error. If your development environment requires you to explicitly release COM references, do not release the COM reference to a SequenceFile object until a call to the Engine.ReleaseSequenceFileEx method succeeds. If you do not specify this option, TestStand might remove the sequence file from the cache if TestStand no longer needs the file.
- ReleaseSeqFile_UnloadFileIfModified –(Value: 0x1) Use this option to remove a modified sequence file from the internal cache of the engine. If TestStand cannot remove a modified sequence file from the cache, the Engine.ReleaseSequenceFileEx method generates an error. If your development environment requires you to explicitly release COM references, do not release the COM reference to a SequenceFile object until a call to the Engine.ReleaseSequenceFileEx method succeeds.