Engine

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

Use the Engine class to create and access objects of other classes, control executions, launch built-in dialog boxes, implement a Tools menu, find files and directories, and invoke various utilities. Create the Engine object directly using ActiveX. To access the Engine object from a step, use the TestStand API to obtain the value of the Engine property from the SequenceContext or pass the SequenceContext property RunState.Engine as an object parameter to the step.

The following are examples of creating the initial Engine object:

LabWindows/CVI

CAObjHandle engineObj = 0;
TS_NewEngine(NULL, &engineObj);

Visual Basic

'Place the TestStand Engine ActiveX control on the main form.

Visual C/C++

#import "C:\TestStand\Bin\teapi.dll"
TS::IEnginePtr engine;
HRESULT hr = engine.CreateInstance(__uuidof(TS::Engine));

Properties

ApplicationIsEditor
ApplicationLicense (Read Only)
AppMainHwnd
BuildVersion (Read Only)
ComputerName (Read Only)
CurrentUser
CurrentWorkspaceFile
DefaultAdapter
DefaultAdapterIndex
DotNetCLRVersion (Read Only)
DotNetGarbageCollectionInterval
ExternalReportViewers (Read Only)
FileDialogDirHistoryList
Globals (Read Only)
GlobalsFile (Read Only)
Images (Read Only)
Is64Bit (Read Only)
IsRemote
IsUIMessageQueueEmpty (Read Only)
LargeImageListEx (Read Only)
LastWorkspacePath
LicenseType (Read Only)
MajorVersion (Read Only)
MasterEngine
MinorVersion (Read Only)
NumAdapters (Read Only)
NumImages (Read Only)
OutputMessagesEnabled
PersistBreakpoints
PersistConfigFile
PersistWatchExpressions
ProfilerOptions
ProfilerOptions
ProfilerOutputMessageCategoryName (Read Only)
ProfilingEnabled (Read Only)
RevisionVersion (Read Only)
SearchDirectories (Read Only)
SecondsAtStartIn1970UniversalCoordinatedTime (Read Only)
SecondsSince1970UniversalCoordinatedTime (Read Only)
SecondsSinceStart (Read Only)
SmallImageListEx (Read Only)
StationOptions (Read Only)
TemporaryGlobals (Read Only)
UIMessagePollingEnabled
UndoLimit
UniqueEngineId (Read Only)
UsersFile (Read Only)
Utility (Read Only)
VersionString (Read Only)
WatchExpressionsEnabled

Methods

AbortAll
AcquireLicense
AddImage
BeginProfiling
BreakAll
CallFrontEndCallbackEx
CanCreateStep
CheckExpression
CheckExprSyntax
ClearFilePasswordCache
CommitGlobalsToDisk
CopyPropertyObject
CreateNewUniqueStepIds
CreateTempFile
CurrentUserHasPrivilege
DelocalizeExpression
DisplayAdapterConfigDialog
DisplayBreakpointDialog
DisplayBrowseExprDialogEx
DisplayBrowsePropertyObjectDialog
DisplayConfigureTypePalettesDialog
DisplayEditBreakAndWatchDialog
DisplayEditPathsInFilesDialog
DisplayEditUserDialog
DisplayExpressionEditOptionsDialog
DisplayExternalViewerDialog
DisplayFileDialog
DisplayHelpFile
DisplayHelpTopic
DisplayLockUnlockDialog
DisplayLoginDialog
DisplayLoopOnStepsDialog
DisplayMessageBox
DisplayNewUserDialog
DisplayOptionsDialog
DisplayPasswordProtectTypeDefinitionsDialog
DisplayPreconditionBuilderDialog
DisplayPreconditionDialog
DisplayRunTimeErrorDialogEx
DisplaySearchDirDialog
DisplaySeqFilePropDialog
DisplaySequenceFileCallbacksDialog
DisplaySequencePropDialog
DisplayStepPropDialog
DisplayStepTypeMenuEditorEx
DisplayToolMenuDialog
DisplayUnlockTypeDefinitionsDialog
DisplayWorkspaceBrowserDialog
DoDotNetGarbageCollection
EndProfiling
ExpandPathMacros
FindFile
FindFileEx
FindPath
GetAdapter
GetAdapterByKeyName
GetCustomConfigFile
GetEditTimeToolMenuItems
GetEngineConfigFile
GetEnvironmentPath
GetErrorString
GetFileInformation
GetImageIndex
GetImageName
GetInsertStepMenuStructure
GetInsertVariableMenuStructure
GetInternalOption
GetLicenseDescription
GetLocalizedDecimalPoint
GetLocationForNextDialog
GetModuleProfiling
GetProductRegistrationInfo
GetRelativePathFromAbsolutePath
GetResourceString
GetResourceSymbols
GetRunTimeToolMenuItems
GetSequenceFileEx
GetStationModelSequenceFile
GetSyncManager
GetTemplatesFile
GetTestStandPath
GetTypeDefinition
GetTypeNames
GetTypePaletteFileList
GetTypes
GetTypeUsageLocations
GetUIMessage
GetUser
GetUserGroup
GetWatchExpressions
GetWatchExpressionsChangeCount
HasAddonLicense
IsCurrentSequenceFileVersion
LaunchExternalViewer
LoadTypePaletteFilesEx
LocalizeExpression
LogProfilerAction
NewCsvFileInputRecordStream
NewCsvFileOutputRecordStream
NewDataType
NewEditArgs
NewEditContext
NewEvaluationTypes
NewExecution
NewExpression
NewHierarchicalExecution
NewInteractiveArgs
NewLocations
NewOutputMessage
NewOutputMessages
NewPropertyObject
NewPropertyObjectFile
NewPropertyObjectType
NewResultLog
NewResultLogger
NewSequence
NewSequenceFile
NewStep
NewStepType
NewTypeUsageList
NewUndoItemCreator
NewUndoStack
NewUser
NewWorkspaceFile
NotifyEndOfModalDialog
NotifyStartOfModalDialogEx
OpenWorkspaceFile
ParseLookupString
PostUIMessage
ReadPropertyObjectFile
RegisterModalWindow
RegisterSequenceToExecuteOnCrash
RegisterUIMessage
RegisterUIMessageCallbackEx
ReleaseLicense
ReleaseSequenceFileEx
ReloadGlobals
ReloadStringResourceFiles
ResetTypeInstances
SaveAllModifiedSeqFiles
SearchFiles
SerializeObjects
SetConfigDirectory
SetInternalOption
SetLocationForNextDialog
SetModuleProfiling
SetTypePaletteFileList
ShouldAutoLaunchExternalReportViewer
ShutDown
TerminateAll
UnloadAllModules
UnloadTypePaletteFiles
UnregisterModalWindow
UnregisterSequenceToExecuteOnCrash
UnserializeObjects
UnserializeObjectsAndTypes
UserNameExists
WriteToolMenuToDisk

Event

UIMessageEvent

See Also

SequenceContext.Engine

WAS THIS ARTICLE HELPFUL?

Not Helpful