List of Engine Callbacks

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

The following table lists the Engine callbacks TestStand defines, indicates where you must define the callback, and specifies when the engine calls the callback.

Engine Callback Where You Define the Callback When the Engine Calls the Callback
SequenceFilePreStep Any sequence file Before the TestStand Engine executes each step in the sequence file.
SequenceFilePostStep Any sequence file After the engine executes each step in the sequence file. The engine does not call this callback when a step errors.
SequenceFilePreInteractive Any sequence file Before the engine begins an interactive execution of steps in the sequence file.
SequenceFilePostInteractive Any sequence file After the engine completes an interactive execution of steps in the sequence file.
SequenceFileLoad Any sequence file When the engine loads the sequence file into memory.
SequenceFileUnload Any sequence file When the engine unloads the sequence file from memory.
SequenceFilePostResultListEntry Any sequence file After the engine fills out the step result for a step in the sequence file.
SequenceFilePostResults Any sequence file After the engine collects a step result in the sequence file and the number of collected results or the time since collected results were last processed exceeds a threshold.
SequenceFilePostStepRuntimeError Any sequence file After a step in the sequence file generates a run-time error.
SequenceFilePostStepFailure Any sequence file After a step in the sequence fails.
ProcessModelPreStep Process model file Before the engine executes each step in any client sequence file the process model calls and each step in any resulting subsequence calls.
ProcessModelPostStep Process model file After the engine executes each step in any client sequence file the process model calls and each step in any resulting subsequence calls. The engine does not call this callback when a step errors.
ProcessModelPreInteractive Process model file Before the engine begins an interactive execution of steps in a client sequence file and steps in any resulting subsequence calls.
ProcessModelPostInteractive Process model file After the engine completes an interactive execution of steps in a client sequence file and steps in any resulting subsequence calls.
ProcessModelPostResultListEntry Process model file After the engine fills out the step result for a step in any client sequence file the process model calls or in any resulting subsequence calls.
ProcessModelPostResults Process model file After the engine collects a step result for a step in any client sequence file the process model calls or in any resulting subsequence calls and the number of collected results or the time since collected results were last processed exceeds a threshold.
ProcessModelPostStepRuntimeError Process model file After a step generates a run-time error when the step is in a client sequence file the process model calls or in any resulting subsequence calls.
ProcessModelPostStepFailure Process model file After a step fails when the step is in a client sequence file the process model calls or in any resulting subsequence calls.
StationPreStep StationCallbacks.seq Before the engine executes each step in any sequence file.
StationPostStep StationCallbacks.seq After the engine executes each step in any sequence file. The engine does not call this callback when a step errors.
StationPreInteractive StationCallbacks.seq Before the engine begins any interactive execution.
StationPostInteractive StationCallbacks.seq After the engine completes any interactive execution.
StationPostResultListEntry StationCallbacks.seq After the engine fills out the step result for a step in any sequence file.
StationPostResults StationCallbacks.seq After the engine collects a step result for a step in any sequence file and the number of collected results or the time since collected results were last processed exceeds a threshold.
StationPostStepRuntimeError StationCallbacks.seq After any step generates a run-time error.
StationPostStepFailure StationCallbacks.seq After any step fails.
Note Note  The threshold is in terms of the number of results the current thread has accumulated and the amount of time since the current thread last called its PostResults callbacks. For more information about the conditions that trigger PostResults callbacks, refer to Execution.PostResultsCallbackOptions, Execution.PostResultsCallbackInterval, Execution.MaximumResultsPerPostResultsCallback, and Thread.FlushPostResults.

See Also

Caveats for Using Engine Callbacks

Overriding PreBatch and PostBatch Model Callbacksl (Example)

Overriding PreUUT and PostUUT Batch Model Callbacks (Example)

Overriding PreUUT and PostUUT Parallel Model Callbacks (Example)

WAS THIS ARTICLE HELPFUL?

Not Helpful