Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Engine

NI TestStand™ 4.1 Help
May 2008

NI Part Number:
370052G-01

»View NI TestStand Product Info

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 get 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
ComputerName (Read Only)
ConfigFile (Read Only)
CurrentUser
CurrentWorkspaceFile
DefaultAdapter
DefaultAdapterIndex
ExternalReportViewers (Read Only)
FileDialogDirHistoryList
Globals (Read Only)
GlobalsFile (Read Only)
Images (Read Only)
IsRemote
IsUIMessageQueueEmpty (Read Only)
LargeImageList (Read Only)
LastWorkspacePath
LicenseType (Read Only)
MajorVersion (Read Only)
MasterEngine
MinorVersion (Read Only)
NumAdapters (Read Only)
NumImages (Read Only)
OutputMessagesEnabled
PersistBreakpoints
PersistConfigFile
PersistWatchExpressions
RevisionVersion (Read Only)
SearchDirectories (Read Only)
SecondsSince1970UniversalCoordinatedTime (Read Only)
SecondsSinceStart (Read Only)
SmallImageList (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
BreakAll
CallFrontEndCallbackEx
CanCreateStep
CheckExpression
CheckExprSyntax
CommitGlobalsToDisk
CopyPropertyObject
CreateNewUniqueStepIds
CreateTempFile
CurrentUserHasPrivilege
DelocalizeExpression
DisplayAdapterConfigDialog
DisplayBreakpointDialog
DisplayBrowseExprDialogEx
DisplayBrowsePropertyObjectDialog
DisplayConfigureTypePalettesDialog
DisplayEditBreakAndWatchDialog
DisplayEditNumericFormatDialogEx
DisplayEditPathsInFilesDialog
DisplayEditUserDialog
DisplayExpressionEditOptionsDialog
DisplayExternalViewerDialog
DisplayFileDialog
DisplayHelpFile
DisplayHelpTopic
DisplayLockUnlockDialog
DisplayLoginDialog
DisplayLoopOnStepsDialog
DisplayMessageBox
DisplayNewUserDialog
DisplayOptionsDialog
DisplayPreconditionBuilderDialog
DisplayPreconditionDialog
DisplayRunTimeErrorDialogEx
DisplaySearchDirDialog
DisplaySeqFilePropDialog
DisplaySequenceFileCallbacksDialog
DisplaySequencePropDialog
DisplayStepPropDialog
DisplayStepTypeMenuEditorEx
DisplayToolMenuDialog
DisplayWorkspaceBrowserDialog
FindFile
FindPath
GetAdapter
GetAdapterByKeyName
GetEditTimeToolMenuItems
GetErrorString
GetFileInformation
GetImageIndex
GetImageName
GetInsertStepMenuStructure
GetInsertVariableMenuStructure
GetInternalOption
GetLicenseDescription
GetLocalizedDecimalPoint
GetLocationForNextDialog
GetProductRegistrationInfo
GetResourceString
GetResourceSymbols
GetRunTimeToolMenuItems
GetSequenceFileEx
GetStationModelSequenceFile
GetSyncManager
GetTemplatesFile
GetTestStandPath
GetTypeDefinition
GetTypeNames
GetTypePaletteFileList
GetTypeUsageLocations
GetUIMessage
GetUser
GetUserGroup
GetWatchExpressions
GetWatchExpressionsChangeCount
IsCurrentSequenceFileVersion
LaunchExternalViewer
LoadTypePaletteFilesEx
LocalizeExpression
NewDataType
NewEditArgs
NewEditContext
NewEvaluationTypes
NewExecution
NewExpression
NewHierarchicalExecution
NewInteractiveArgs
NewLocations
NewOutputMessage
NewOutputMessages
NewPropertyObject
NewPropertyObjectFile
NewSequence
NewSequenceFile
NewStep
NewStepType
NewTypeUsageList
NewUndoItemCreator
NewUndoStack
NewUser
NewWorkspaceFile
NotifyEndOfModalDialog
NotifyStartOfModalDialogEx
OpenWorkspaceFile
ParseLookupString
PostUIMessage
RegisterModalWindow
RegisterUIMessage
RegisterUIMessageCallback
ReleaseLicense
ReleaseSequenceFileEx
ReloadGlobals
ReloadStringResourceFiles
ResetTypeInstances
SaveAllModifiedSeqFiles
SearchFiles
SerializeObjects
SetConfigDirectory
SetInternalOption
SetLocationForNextDialog
SetProductRegistrationInfo
SetTypePaletteFileList
ShouldAutoLaunchExternalReportViewer
ShutDown
TerminateAll
UnloadAllModules
UnloadTypePaletteFiles
UnregisterModalWindow
UnserializeObjects
UnserializeObjectsAndTypes
UserNameExists
WriteToolMenuToDisk

Event

UIMessageEvent

See Also

SequenceContext.Engine


Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit