Test Stand APIReference Poster
Test Stand APIReference Poster
NI TestStand API
TM
Execution Classes PropertyObject Classes Step Classes Adapter Classes
An execution is an object TestStand creates to contain all the Use the PropertyObject class to manipulate and access the values of variables and custom step Objects of the StepType class represent step types in TestStand The adapter-specific and module-
information it uses to run the sequences and subsequences it properties. Use the AsPropertyObject method on a class that derives from the PropertyObject files, and objects of the Step class represent steps in TestStand specific classes derive from the
NI TestStand provides a comprehensive ActiveX Automation server application programming interface (API) for building sophisticated test
calls. Use objects of this class to control and get information
about executions. Use objects of the Report class to modify,
class to obtain the PropertyObject interface for that class. Typically, you use the PropertyObject
class to get or set the values of custom step properties, sequence local variables, sequence file global
sequences. Every step is an instance of a step type. A StepType
object defines default properties and values as well as standard
Adapter and Module base classes.
Use the Adapter base class to Common C Adapter Classes
management systems and other sequencing applications. Use the TestStand API to read and write data from TestStand properties, including save, load, retrieve, and view reports. variables, and station global variables. behaviors for each step of that type. A Step object defines configure and obtain information
TestStand sequences and steps, or to create, edit, run, and debug sequences. You can access the TestStand API from any programming the code module to call, required preconditions, looping about the module adapters. Use
environment that supports access to ActiveX servers. Threads are elements of an Execution. Each thread maintains Use the PropertyObjectType class to get type information for a PropertyObject. Use the and switching requirements, and failure and error handling the Module base class to specify The module and parameter classes for the LabWindowsTM/CVITM and C/C++ DLL Adapters derive from the CommonCAdapter and
a call stack that contains a SequenceContext object for each ArrayDimensions class to obtain and set array bounds information for a PropertyObject. instructions. and obtain information about code CommonCModule classes. Use these classes to set and get information about the C-style adapters, code modules, and parameters.
Refer to the NI TestStand Help for a complete description of all TestStand API classes, properties, methods, and events. active sequence invocation. The SequenceContext class contains modules that steps or step type
GetInstanceOverrideFlags SetValInteger64
complete information about an execution at a particular point ArrayDimensions GetLocation SetValInteger64ByOffset Step ExecuteSubstep
substeps execute. CommonCAdapter CommonCParameter CVIModule DllArguments
GetBreakSettings
Note Some properties and methods from previous versions of TestStand are obsolete and not listed on this poster. during the execution. Properties GetNthSubProperty SetValInterface
PropertyObject GetDescriptionEx PropertyObject PropertyObject PropertyObject DllArgument
DisplayString (Read Only) GetNthSubPropertyName SetValInterfaceByOffset
Location LowerBoundsString (Read Only) GetNumElements SetValNumber Step
GetEditSubstepMenuStructure
Adapter Adapter CommonCParameter Module Properties
EditArgs ReportSection UpperBoundsString (Read Only) GetNumSubProperties SetValNumberByOffset
GetResultStatusDisplayString
GetRunModeEx PropertyObject
ImaginaryPartValue
Properties CommonCAdapter Properties CommonCModule Value
ResetCount (Read Only) GetPropertyObject SetValString GetStepSettingsString
PropertyObject Methods GetPropertyObjectByOffset SetValStringByOffset AdapterKeyName (Read Only) ArrayDimensions
StyleSheetPath GetDimensionSize LoadModule Adapter Property CVIModule Methods
EditArgs GetPropertyObjectElements SetValUnsignedInteger64 AdditionalResults (Read Only) DisplayValueExpr (Read Only)
SuspendReportRefresh GetLowerBounds LogAdditionalResult DefaultStructPacking This class has no methods.
GetStructureChangeCount SetValUnsignedInteger64ByOffset AdditionalResultsHints (Read Only) Properties EnumTypeName (Read Only) Properties
Properties Methods GetUpperBounds SetBreakSettings Methods Flags AlwaysRunInProcess
GetSubProperties SetValVariant BatchSyncOption DisplayName (Read Only)
SetBounds SetRunModeEx AsAdapter ParameterName ModuleType
This class has no properties. Append
AsPropertyObject SetBoundsByStrings
GetSubPropertyIndex SetValVariantByOffset BlockEndIndex
BlockFlags
SpecifyModule
Hidden
IconName (Read Only) GetAllowStructPassing Pass Parameters (ReadOnly)
DllFunctions
Methods GetTypeDefinition SetXML UnloadModule
AddSelectedPropertyObject
GetSection GetTypeDefinitionProtection UnlockTypeDefinition BlockLevel IsConfigurable (Read Only) GetDIIFunctions PassArrayElementBy
Methods DllFunction
GetTempFile GetExcludeFromStruct ResultAction
AddSelectedSequence PropertyObject GetTypeFlags UnserializeEx BlockLevelsUnmatched KeyName (Read Only)
GetStructMemberArrayStorage StringBufferSizeExpr
AsCommonCModule Properties
AddSelectedStep
LaunchViewer
Load Properties
GetValBinary ValidateNewElementName BlockNextIndex StepType LargeIcon (Read Only)
LargeIconIndex (Read Only) GetStructMemberStorage StructType
Execute DisplayName (Read Only)
AsPropertyObject GetValBoolean ValidateNewName BlockParentIndex
NewReportSection ArrayElementPrototype PropertyObject ShowArgsInStepDescription GetStructMemberStringBufferSize UnknownInfo HasParameterInformation (Read Only)
ClearSelectedPropertyObjects GetValBooleanByOffset ValidateNewSubPropertyName BlockPreviousIndex
Refer to the NI Trademarks and Logo Guidelines at ni.com/trademarks for more information on National Instruments trademarks. Other product and company names mentioned herein are trademarks or HelpContext (Read Only)
trade names of their respective companies. For patents covering National Instruments products/technology, refer to the appropriate location: Help»Patents in your software, the patents.txt file on your ClearSelectedSequences
RefreshDisplay Attributes (Read Only) GetValIDispatch Write BlockStartIndex
StepType
SmallIcon (Read Only) GetStructMemberType UserData (Read Only) CVIParameters HelpFilePath (Read Only)
Reset CanAddSubProperty (Read Only) GetValIDispatchByOffset CancelCurrentExecution SmallIconIndex (Read Only) GetStructNames ValidEvaluationTypes (Read Only)
media, or the National Instruments Patent Notice at ni.com/patents. You can find information about end-user license agreements (EULAs) and third-party legal notices in the readme file for your NI product. ClearSelectedSteps
SetSelectedExecution
Save Comment GetValInteger64 CancelCurrentModuleExecution Properties Methods
GetStructPacking ValueExpr CVIParameter ParameterTypeWarnings (Read Only)
Refer to the Export Compliance Information at ni.com/legal/export-compliance for the National Instruments global trade compliance policy and how to obtain relevant HTS codes, ECCNs, and other
import/export data. SetSelectedPropertyObjectFile
SetTempFileDirectoryEx HasAttributes (Read Only) GetValInteger64ByOffset PropertyObjectType CancelStepCallback AdditionalResultsHints (Read Only) AsPropertyObject
SetAllowStructPassing ValueExprIsIgnored (Read Only)
PropertyObject
SymbolName (Read Only)
UniqueDisplayName (Read Only)
HasTypeAttributes (Read Only) GetValInterface CanCreateCode (Read Only) SetExcludeFromStruct ValueExprIsOptional (Read Only)
SetSelectedSequenceFile Properties AppliesToBlockStructure Configure
IsModifiedType GetValInterfaceByOffset CanEditCode (Read Only) SetStructMemberArrayStorage Methods CommonCParameter Methods
© 2003–2013 National Instruments. All rights reserved. Printed in Ireland. SetSelectedStepGroup ReportSections IsRootTypeDefinition (Read Only) GetValNumber
ArrayDimensions (Read Only)
DisplayString (Read Only) CanSpecifyModule (Read Only)
BatchSyncOption
BlockEndTypes
SetStructMemberStorage AsPropertyObject This class has no methods.
CVIParameter
ReportSection IsTypeDefinition (Read Only) GetValNumberByOffset ElementType (Read Only) CausedSequenceFailure BlockStartTypes Module SetStructMemberStringBufferSize GetArrayDimensionSizeExpr
Execution Name GetValString IsObject (Read Only) CurrentLoopResult CanEncapsulate
PropertyObject
SetStructMemberType
SetStructPacking
GetDescription
GetEnumValues
Properties
DllModule
PropertyObject NumericFormat GetValStringByOffset CustomActionExpression CanSpecifyModule (Read Only) Category
Engine Classes
GetDescription VisualStudioDTEVersionForDebugging
ModelSequenceFilePath (Read Only) PropertyObject DeleteSubProperty SetInstanceDefaultFlags LoopInitExpression LoopIncExpression WorkspaceFilePath ExecuteStepsInExternalInstance
VisualStudioDTEVersionForEditing
NumThreads (Read Only)
SequenceContext
DisplayArrayBoundsDialog SetInstanceOverrideFlags LoopStatusExpression LoopInitExpression
GetLastLoadWarnings
Load Methods
ExecutionServerProjectPathName DllParameters
OverrideNonTerminatableThreads SetNthSubPropertyName LoopType LoopStatusExpression Methods
PostResultsCallbackInterval
DisplayAttributesDialog
DisplayEditNumericFormatDialog SetNumElements LoopWhileExpression LoopType
LoadPrototype AcceptFunctionCall Methods AsAdapter DllParameter
Properties Module (Read Only) Specify AsModule AsAdapter
AsCommonCAdapter
PostResultsCallbackMask DisplayFlagsDialog SetPropertyObject LoopWhileExpression PropertyObject
ApplicationIsEditor (Read Only) Unload LoadPrototypeFromCodeTemplate AsCommonCAdapter
PostResultsCallbackOptions SetPropertyObjectByOffset ModuleLoadOption NewModule
Use the Engine class to create and access objects of other classes, control executions, launch built-in dialog boxes, implement a Tools PostResultsCallback_PostFlushMask
Caller (Read Only) DisplayPropertiesDialog
SetSubPropertyIndex ModuleUnloadOption
MenuGroupName UpdatePrototypeFromSource NewModule
CommonCParameter
CallerDiscardsResults (Read Only) EvaluateEx MenuIcon (Read Only) VerifyPrototype
menu, find files and directories, and invoke various utilities. Use the StationOptions class to set preferences for TestStand. Use the PostResultsCallback_PreFlushMask Exists SetTypeDefinitionProtection MutexNameOrRefExpr MenuIconIndex (Read Only) UnmappedArgumentValues VerifyPrototypeFromSource
CallingStep (Read Only) DllParameter
UIMessage class to pass information about the state of the engine and the current executions to the TestStand User Interface or TestStand Report (Read Only)
CallStackDepth (Read Only) GetArrayIndex SetTypeFlags Name MenuItemNameExpr CVIArguments
Sequence Editor. Use objects of the WatchExpression class to monitor the values of properties and variables using expressions.
Reports (Read Only) GetArrayOffset SetValBinary PassAction Module (Read Only) UnmappedArgumentValue Properties
ResultObject (Read Only)
CallStackName (Read Only)
CanTrace (Read Only) GetDisplayNames SetValBoolean PassActionTargetByExpr ModuleLoadOption CVIArgument Category
ResultStatus SetValBooleanByOffset PostExpression PropertyObject
Engine (Read Only) GetFlags ModuleUnloadOption Property ImaginaryPartValueExpr
DisplayLoopOnStepsDialog CheckOutOnlySelectedFiles Precondition
AdditionalResults DisplayMessageBox
Evaluation Types DebugOptions
RTEOptionForThisExecution
RunTimeVariables (Read Only)
ErrorReported GetFormattedValue SetValIDispatch
SetValIDispatchByOffset PreExpression
MutexNameOrRefExpr UnmappedArgumentValue Value TSObjectParameterType
Execution (Read Only) GetInstanceDefaultFlags Name Type
AdditionalResult DisplayNewUserDialog Properties DefaultCPUAffinityForThreads SecondsAtStart (Read Only)
FileGlobals (Read Only)
RecordLoopIterationResults NumSubsteps (Read Only) Properties Methods
Method
DisplayOptionsDialog AllowedArrayRepresentations DefaultFileWritingFormat SecondsExecuting (Read Only) Continued, next column Continued, next column Requirements (Read Only) PassAction Name (Read Only) This class has no methods.
Properties DisplayPasswordProtectTypeDefinitionsDialog AllowedRepresentations DisableResults GotoCleanup ResultRecordingOption AsCommonCParameter
SecondsSuspended (Read Only) PassActionTargetByExpr TypeName (Read Only)
AreElementsIncompatibleWithType (Read Only) DisplayPreconditionBuilderDialog ArrayOfNamedTypes EnableUserPrivilegeChecking Id (Read Only) ResultStatus
SequenceFilePath (Read Only) PostExpression UnmappedArgumentValues (Read Only)
CheckedState DisplayPreconditionDialog NamedTypes ExecutionMask InInteractiveMode (Read Only) Sequence (Read Only)
StandardResultsEnabled Precondition ValueExpr (Read Only)
Condition DisplayRunTimeErrorDialogEx PropertyValueTypeFlags FileModificationIndicatorPolicy InteractiveContext (Read Only) SmallIcon (Read Only)
StartCount (Read Only) PreExpression
Elements (Read Only) DisplaySearchDirDialog InteractiveBranchMode IsProcessModel (Read Only) SmallIconIndex (Read Only) Methods
Methods TerminateNonTerminatableThreadsPrompt RecordLoopIterationResults
Flags DisplaySeqFilePropDialog InteractiveExePropagateStatus Locals (Read Only) StatusExpression This class has no methods.
This class has no methods. ThreadIds (Read Only) ResultRecordingOption
Kind (Read Only) DisplaySequenceFileCallbacksDialog Language LoopIndex StepFailCausesSequenceFail
TimeResultsEnabled RunMode
IsAnyType DisplaySequencePropDialog PreloadProgressDelay LoopNumFailed StepGroup (Read Only)
TracingDisabled StatusExpression
Name LoopNumIterations
Expression
File Classes
DisplayStepPropDialog PromptToFindFiles TypeMask StepIndex (Read Only) StepFailCausesSequenceFail
ParameterObject (Read Only) DisplayStepTypeMenuEditorEx PromptWhenAddingFilesToSC LoopNumPassed StepType (Read Only)
Methods Main (Read Only) SwitchExecConnectionLifetime
ParentAdditionalResult (Read Only) DisplayToolMenuDialog Properties RecognizeMBChars SwitchExecConnectionLifetime SwitchExecEnabled
Type DisplayUnlockTypeDefinitionsDialog NumTokens (Read Only) ReloadDocsWhenOpeningWorkspace Abort NextStep (Read Only) SwitchExecEnabled
AddExtraResult NextStepIndex SwitchExecMulticonnectMode
UnmappedAdditionalResults (Read Only) DisplayWorkspaceBrowserDialog Text ReloadWorkspaceAtStartup SwitchExecMulticonnectMode
AddPostStepCustomUIMessage NumStepsExecuted SwitchExecOperation
ValueToLog
Adapter-Specific Classes
DoDotNetGarbageCollection Methods RequireUserLogin SwitchExecOperation SwitchExecOperationOrder
Methods FindFile Evaluate RTEOption AsPropertyObject Parameters (Read Only) Use the PropertyObjectFile class to read and write PropertyObjects to disk. All TestStand files, SwitchExecOperationOrder SwitchExecRoutesToConnect
Break PreviousStep (Read Only)
This class has no methods. FindPath GetConstantValue SeqFileVersionAutoIncrementOpt
CancelTermination PreviousStepIndex including sequence files, type palette files, workspace files, configuration files, the users file, and the SwitchExecRoutesToConnect SwitchExecRoutesToDisconnect
GetAdapter GetToken ShowEngineTrayIconOnRemoteStations SwitchExecRoutesToDisconnect SwitchExecVirtualDevice
GetAdapterByKeyName Tokenize ShowHiddenProperties ClearExtraResultList ProcessModelClient globals file, are stored as PropertyObjectFiles. SwitchExecVirtualDevice SwitchExecWaitForDebounce
EditTimeMenuItems GetEditTimeToolMenuItems Validate SpecifyStepsByUniqueIdInExpressions ClearSequenceDefaultValues
ClearTemporaryBreakpoints
Report (Read Only)
Root (Read Only)
SwitchExecWaitForDebounce UseMutex
GetErrorString StationID Objects of the SequenceFile class represent a sequence file that can contain sequences, and objects UniqueStepId (Read Only) The adapter-specific classes include classes that represent module adapters, code modules that adapters call, and parameters that code modules require. Use the adapter-specific classes
EditTimeMenuItem GetFileInformation
ValidateEvaluationType
StationModelSequenceFilePath DeleteExtraResult SelectedExecution (Read Only) UseMutex
WindowActivation
GetImageIndex SystemDefaultSourceCodeControlProvider EnableCallback SelectedFile (Read Only) of the Sequence class represent a sequence that can contain steps. Objects of the WorkspaceFile WindowActivation Methods to configure and obtain adapter-specific information about the module adapter. Use the module-specific classes to specify and obtain adapter-specific information about the code
Properties
CommandArguments GetImageName ExternalReportViewers TracingEnabled GetFileGlobals SelectedPropertyObjectFile (Read Only) class represent workspace files that can contain projects. Objects of the WorkspaceObject class Methods
AddSubstep module that steps or step type substeps execute. Use the parameter-specific classes to specify the type, direction, and expression value of a parameter. Refer to the NI TestStand Help
GetInsertStepMenuStructure TypeVersionAutoIncrementOpt GetModelSequenceFile SelectedPropertyObjects (Read Only) AsPropertyObject
CommandInitialDirectory
ExternalReportViewer GetSequenceDefaultValues SelectedSequences (Read Only) represent nodes for workspace and project files on the Workspace pane. Objects of the User class AsPropertyObject ChangeDesignatedAdapter for more information about how to best use LabVIEW features in a TestStand system.
CommandPath GetInsertVariableMenuStructure TypeVersionAutoIncrementPromptOpt
Editable GetInternalOption Properties UIMessageDelay GetSequenceFile SelectedStepGroup represent the data and privileges TestStand associates with a TestStand user or user group. The CanChangeAdapter CreateCombinedStepType
CanChangeStepType DefaultValue (Read Only) DisplayType (Read Only)
EditsSelectedFile GetLicenseDescription Arguments UIMessageMinDelay GetStates
GetTerminationMonitorStatus
SelectedSteps (Read Only)
Sequence (Read Only) UsersFile class represents the files that contain a list of TestStand users and user profiles. CanExecuteSubstep
DimProperty ActiveXAdapter ActiveXServers Direction (Read Only)
LabVIEWModule ElementCaption (Read Only)
GetLocalizedDecimalPoint UseDialogForCheckOut GetDefaultName
EnabledExpression
HiddenExpression GetLocationForNextDialog
AutoLaunch
UseLocalizedDecimalPoint GetThread SequenceErrorCode ChangeAdapter GetDimmablePropertyDisplayName PropertyObject ActiveXServer DisplayType (Read Only) PropertyObject ElementName (Read Only)
GetProductRegistrationInfo
Format
UserFilePath InitTerminationMonitor SequenceErrorMessage ResultLogger objects write TestStand results to a file. Use a ResultLog object to read the results ChangeStepType GetSubstep DisposeObject Elements (Read Only)
ItemTextExpression Path IsCallbackEnabled SequenceErrorOccurred CreateCode Adapter Properties Elements (Read Only) Module IndexString (Read Only)
SeparatorBefore GetResourceString UseStationModel
SequenceFailed
from the file. CreateNewUniqueStepId
IsPropertyDimmed
CoClasses (Read Only) Flags (Read Only) IsNodeUsingDefault
GetResourceSymbols Methods NewSequenceDefaultValues RemoveSubstep ActiveXAdapter LabVIEWModule
SequenceFilePath Methods SequenceFile (Read Only) DisplayAdditionalResultsDialog DisplayName (Read Only) HelpString (Read Only) PartiallySpecified (Read Only)
GetRunTimeToolMenuItems This class has no methods. NewThread SpecifyModule
LoadModules
SequenceName
SubMenuItems (Read Only) GetSequenceFileEx
GetLanguages RemovePostStepCustomUIMessage SequenceIndex (Read Only) CodeTemplates ResultLogger NewEditContext
EditCode SwapSubsteps Properties HelpContext (Read Only)
HelpFilePath (Read Only)
ParameterName (Read Only) Properties PassAsBinaryString
GetTimeLimit RestartEx StationGlobals (Read Only) Servers (Read Only) Type (Read Only) CallName Type (Read Only)
Type GetStationModelSequenceFile
GetSyncManager Images GetTimeLimitAction RestartWithNewArguments Step (Read Only) CodeTemplate PropertyObject RemoveSequence Continued, next column ShowActiveXControlsWhenSpecifyingModule Id (Read Only) TypeName (Read Only) CallType TypeDisplayString (Read Only)
GetTimeLimitEnabled Save UnloadUnusedActiveXServersAfterExec Interfaces (Read Only) UseDefaultValue ClassPath UseDefaultValue
Methods GetTemplatesFile Resume StepGroup Properties ResultLogger
Properties SetTimeLimit SequenceNameExists UseLateBinding LibraryFlags (Read Only) UserData (Read Only) ExpressVIName (Read Only) UserData (Read Only)
This class has no methods. GetTestStandPath SetSequenceDefaultValues StepGroupStartedInteractiveExe (Read Only) Description (Read Only)
Count (Read Only) SetTimeLimitAction UnloadModules LocaleId (Read Only) ValidEvaluationTypes (Read Only) HelpContext (Read Only) ValidEvaluationTypes (Read Only)
GetTypeDefinition Item (Read Only)
StepInto StepIndex Name (Read Only) Property Methods
SetTimeLimitEnabled Thread (Read Only) MajorVersion (Read Only) ValueExpr HelpFilePath (Read Only) ValueExpr
GetTypeNames StepOut Type (Read Only) Path AsAdapter
Engine GetTypePaletteFileList Method StepOver Tracing RecordFilesWritten User UpdateAutomationIDs
MinorVersion (Read Only)
Name (Read Only)
ValueExprIsIgnored (Read Only) HelpPicture (Read Only) ValueExprIsIgnored (Read Only)
FindImage Terminate Methods ValueExprIsOptional (Read Only) HelpPictureRects (Read Only) ValueExprIsOptional (Read Only)
Properties GetTypes StepAdditionalResults TerminateInteractiveExecution
Methods This class has no methods. Methods PropertyObject Path (Read Only)
Methods
Namespace WireRequirement (Read Only)
ApplicationIsEditor GetTypeUsageLocations AsPropertyObject Close VersionString (Read Only)
Properties WaitForEndEx ActiveXCoClasses NodeClassDataName
OutputMessages
Analyzer Classes
ApplicationLicense (Read Only) GetUIMessage GetMultipleValues ContinueInNewFile User AsPropertyObject Methods
Method NodeIgnoresInternalErrors
AppMainHwnd GetUser CustomResults (Read Only) GetRunTimeErrorMessageEx FileInformation DeferrableRename ActiveXCoClass DeleteArrayElement
NodeLibraryGenericTypeName
AsPropertyObject
BuildVersion (Read Only) GetUserGroup OutputMessage ParameterResults (Read Only)
InteractiveArgs GetRunTimeErrorWinHelpInfo
Properties
Flush Properties LoadTypeLibrary DisplayCreateCustomDataTypeDialog
NodeLibraryName
CreateDefaultArrayElements
ComputerName (Read Only) GetWatchExpressions Methods IsInteractiveStep GetFilesWritten FullName Properties GetEnumValues DeleteArrayElement
PropertyObject FileExists (Read Only) NodeOperationMode
ConfigFile (Read Only) GetWatchExpressionsChangeCount LoginName Documentation (Read Only) InsertArrayElement DeleteArrayElements
CurrentUser IsCurrentSequenceFileVersion
This class has no methods. PropertyObject IsStepExcludedFromExecution
NewExecution
FileWritingFormat (Read Only)
LogBatchDone
LogBatchStart Members (Read Only) HelpContext (Read Only)
DotNetAdapter IsStructMappingInvalid
NodeProperties (Read Only)
DisplayCreateCustomDataTypeDialog
OutputMessage NodeUsesDataValueReference
CurrentWorkspaceFile LaunchExternalViewer InteractiveArgs
SetMultipleValues
IsCustomFile (Read Only)
LogBegin Password Use the AnalysisContext class in an analysis module to access HelpFilePath (Read Only) PropertyObject ExprClusterTypeMismatch
Parameters (Read Only)
DefaultAdapter LoadTypePaletteFilesEx Properties TypeUsageList Properties
IsCVIDll (Read Only)
IsDotNetAssembly (Read Only)
LogEnd Privileges (Read Only) information about the current object being analyzed or about the Id (Read Only)
Adapter HTBasicAdapter ProjectPath
GetArrayIndex
DefaultAdapterIndex LocalizeExpression Category LogOnTheFlyStepResults Interfaces (Read Only) GetDefaultArrayDimensionSize
LoopCount Methods current analysis transition. An object of the AnalysisMessage
DotNetCLRVersion (Read Only) NewDataType ExecutionLocations
Properties
ChangeCount (Read Only) NumSteps (Read Only)
Thread IsPropertyObjectFile (Read Only)
LogPostBatch AsPropertyObject
Name (Read Only) DotNetAdapter PropertyObject
RemoteConnectionTimeout
RemoteHost
GetEnumValues
IsSequenceFile (Read Only)
DotNetGarbageCollectionInterval NewEditArgs FileLocations
NumTypes (Read Only) Sequence PropertyObject PropertyObjectFileType (Read Only)
LogPostUUT HasPrivilege class represents a message an analysis module creates while TypeFlags (Read Only)
RemotePortNumber
InsertArrayElement
ExternalReportViewers (Read Only) NewEditContext IconName LogPreBatch Properties Adapter IsClusterMappingInvalid
FileDialogDirHistoryList NewEvaluationTypes Id (Read Only) Methods
StepGroup ValidatePassword performing an analysis. Use objects of the AnalysisUtilities Method
VisualStudioDTEVersionForDebugging
RemoteProjectPath
UpdateClusterMapping
StopExpression Thread Methods LogPreUUT GetInterfaceImplementationTypeFlags HTBasicAdapter RemoteVIPath
Globals (Read Only) NewExecution Message AddUsedTypes GetFileFormatVersion LogUUTDone class in an analysis module to perform common analysis VisualStudioDTEVersionForEditing
SpecifyHostByExpression
GlobalsFile (Read Only) NewExpression Severity CreateAndInsertNewTypeFromExisting Methods Properties GetFileVersion LogUUTStart UsersFile functions. Methods Properties VIAttached (Read Only) LabVIEWNodeProperties
Images (Read Only) NewHierarchicalExecution
NewInteractiveArgs
TextColor GetIsTypeAttachedToFile AddStepIndex
AsPropertyObject
Batch (Read Only)
CallStackSize (Read Only)
Open
PropertyObject
ActiveXInterfaces AsAdapter DefaultWorkingDirectory VICallOptions
IsRemote
IsUIMessageQueueEmpty (Read Only) NewLocations
TimeInSeconds
TimeStamp
GetTypeDefinition
GetTypeIndex ClearStepList DisplayName (Read Only) InputStream Use the objects of the RuleConfiguration class to access ActiveXInterface CacheAssemblyInfo DevelopmentServerPath VIDescription (Read Only) LabVIEWNodeProperty
RunTimeServerPath
LargeImageList (Read Only) NewOutputMessage
Methods
InsertType ContainsStep Execution (Read Only)
Properties
Sequence UsersFile
the configuration information of a rule. Use the objects of Properties
GetClassNames
GetExcludeFromStructure SpecWorkingDirectoryPath
VIPath
VIType
PropertyObject
LastWorkspacePath NewOutputMessages MoveType GetStepIndex ExternallySuspended Properties UseDevelopmentServer
LicenseType (Read Only) NewPropertyObject
AsPropertyObject
RemoveType Id (Read Only) IsEndofStream (Read Only) PropertyObject
UserGroupList
the RuleConfigurationContext class in a rule configuration DispatchMembers (Read Only) GetGACAssemblyStrongNames
Methods LabVIEWNodeProperty
Post Length (Read Only) Documentation (Read Only) GetMemberNames Method
MajorVersion (Read Only) NewPropertyObjectFile SetIsTypeAttachedToFile
InteractiveContext
RunTimeVariables (Read Only)
Offset Sequence UserList module to access the rule configuration data. Use objects of the ForTypedefOnly (Read Only) GetStructureMemberLabel
AsModule
Properties
MasterEngine NewPropertyObjectType Union TerminationOption AsAdapter ConvertExpressVIToStandardVI
Path (Read Only) Methods RuleSettingValues class to obtain rule setting values. HelpContext (Read Only) GetStructurePassingEnabled DataName
MinorVersion (Read Only)
NumAdapters (Read Only)
NewResultLog
NewResultLogger
RunTimeMenuItems ValidateNewTypeName PropertyObject UniqueThreadId (Read Only)
Method
Properties
AllowInteractiveExecutionOfEntryPoint AsPropertyObjectFile HelpFilePath (Read Only) IsClassValid
ConvertToStandardVI
CreateProject
Direction
NumImages (Read Only) NewSequence RunTimeMenuItem InteractiveContext
Methods
ReadBytes CopyStepsOnOverride ReloadFromDisk
AnalysisContext RuleConfiguration
Id (Read Only) NewModule HTBasicModule DisplayParameterMappingDialog
LongName
OutputMessagesEnabled NewSequenceFile UIMessage AddToBatch
AsPropertyObject
DisableResults
Name (Read Only) SetExcludeFromStructure
PropertyObject DisplaySelectClassFromProjectDialog
UniqueID
NewStep
Properties Properties EntryPointCheckToSaveTitledSeqFiles Properties Properties TypeFlags (Read Only) SetStructureMemberLabel
DisplaySelectClassMemberFromProjectDialog Methods
PersistBreakpoints
PersistConfigFile NewStepType
EditsSelectedFile (Read Only) PropertyObject InteractiveArgs (Read Only) ClearCurrentRTE PropertyObjectFile EntryPointEnabledExpression
WorkspaceFile AnalysisId (Read Only) ConfigurationData (Read Only) VTableMembers (Read Only) SetStructurePassingEnabled Module DisplaySelectMemberFromClassDialog AsPropertyObject
ItemEnabled (Read Only) IsRootExecution (Read Only) ClearTemporaryBreakpoint EditContext (Read Only) Description
PersistWatchExpressions NewTypeUsageList UIMessage DoInteractiveExecution PropertyObject
EntryPointIgnoreClient PropertyObject Methods HTBasicModule DisplaySelectVIFromProjectDialog
SeparatorBefore (Read Only) SavedNextStepIndex (Read Only) Engine (Read Only) Enabled
RevisionVersion (Read Only) NewUndoItemCreator
SubMenuItems (Read Only) Properties SavedPreviousStepIndex (Read Only) FlushPostResults
EntryPointInitiallyHidden
WorkspaceFile File (Read Only) RuleId (Read Only)
This class has no methods. DotNetModuleArguments EditClass
SequenceAdapter
SearchDirectories (Read Only) NewUndoStack GetSequenceContext PropertyObjectFile EntryPointMenuHint Properties EditProject
SecondsAtStartIn1970UniversalCoordinatedTime (Read Only) NewUser
Text (Read Only) ActiveXData (Read Only) SavedStepIndex (Read Only) EntryPointNameExpression Object (Read Only) RuleSettingValues (Read Only) DotNetArguments ShowHTBasicApp Execute
SecondsSince1970UniversalCoordinatedTime (Read Only) NewWorkspaceFile Method Event (Read Only) Method
PostUIMessageEx Properties FailureAction
Properties StopRequested (Read Only) Severity ActiveXMembers SubroutineFilePath ExportVI
PropertyObject
NotifyEndOfModalDialog Execution (Read Only)
Resume ChangeCount HasMismatchedBlocks (Read Only)
IsConnectedToSCProvider (Read Only) Transition (Read Only) DotNetArgument FindClassUrlUsingClassPath
SecondsSinceStart (Read Only)
SmallImageList (Read Only) NotifyStartOfModalDialogEx
InvokeItem
IsSynchronous (Read Only)
AsPropertyObject SetBatchRTEOption Comment Id (ReadOnly)
OptionsFile (Read Only) Utilities (Read Only)
Methods ActiveXMember SubroutineName
WorkingDirectory FindVIUrlUsingVIPath
Adapter
SetStepInto ProviderName This class has no methods. Properties SequenceAdapter
StationOptions (Read Only) OpenWorkspaceFile NumericData (Read Only) ContentType Locals (Read Only) Properties WorkingDirectorySpecifiedPath GetClassAbsolutePath
Methods Elements (ReadOnly)
TemporaryGlobals (Read Only) ParseLookupString SearchDirectories StringData (Read Only) Reports SetStepOut
SetStepOver
Data Name
RootWorkspaceObject (Read Only)
GetRuleAnalysisData DispatchId (Read Only) ParameterName (ReadOnly) Method
GetProjectUrlPathsForClasses Properties
UIMessagePollingEnabled PostUIMessage
SearchDirectory
Thread (Read Only)
Report WaitForEnd
DisplayName OptimizeNonReentrantCalls Methods GetRuleConfiguration RuleConfigurationContext Documentation (Read Only) Value AsModule
GetProjectUrlPathsForVIs This class has no properties.
UndoLimit ReadPropertyObjectFile EditPrivilege Parameters (Read Only) AsPropertyObjectFile FunctionFlags (Read Only) GetVIAbsolutePath
Methods NewMessage Properties
UniqueEngineId (Read Only) RegisterModalWindow Properties FileSection Requirements (Read Only) DisplayAddFileToWorkspaceDialog HelpContext (Read Only) Methods ImportVI Methods
Acknowledge PropertyObject ReportMessage Engine (Read Only)
FileType (Read Only) This class has no methods. AsAdapter
UsersFile (Read Only) RegisterUIMessage
RegisterUIMessageCallback
Disabled AsPropertyObject
Report FileTypeDescription
SequenceFile (Read Only)
SequenceIndex (Read Only)
FindWorkspaceObject
RunSourceControlProvider
StopAnalysis IsModified
HelpFilePath (Read Only)
MemberType (Read Only)
LabVIEWAdapter IsProjectValid
LoadVIInfo GetSequenceFile
Utility (Read Only) ExcludeFileExtension
FileWritingFormat RuleConfiguration (Read Only)
ReleaseLicense ShowEntryPointForAllWindows SaveWorkspaceAndProjectFiles Name (Read Only) PropertyObject
VersionString (Read Only)
WatchExpressionsEnabled ReleaseSequenceFileEx
ExcludeHiddenSubdirectories
Utility Properties Id (Read Only) ShowEntryPointForEditorOnly AnalysisMessage Methods ParameterTypeWarnings (Read Only)
DotNetCalls
ReloadGlobals
FileExtensionRestrictions
Path All (Read Only) IsDiskFileModified (ReadOnly) ShowEntryPointForExeWindow This class has no methods. VTableOffset (Read Only) DotNetCall Adapter LabVIEWParameters SequenceCallModule
Methods ReloadStringResourceFiles Properties Format IsDiskFileReadOnly (Read Only) ShowEntryPointForFileWindow WorkspaceObject Properties
AbortAll
ResetTypeInstances
SearchSubdirectories
Type (Read Only)
Escape Id (Read Only) IsModified (Read Only) Type
Locations (Read Only) Methods Properties
LabVIEWAdapter LabVIEWParameter PropertyObject
AcquireLicense
SaveAllModifiedSeqFiles Unescape IsEmpty (Read Only) IsModifiedByUser (Read Only)
Methods
PropertyObject RuleId RuleSettingValues This class has no methods. CallIndex (Read Only) Properties PropertyObject Module
AddImage
SearchFiles
Methods LatestAppendIndex (Read Only) Locked (Read Only) WorkspaceObject
Text ClassHelpString (Read Only) AdditionalThreadsInheritCallingThreadsCPUAffinity
BreakAll This class has no methods.
Methods AsPropertyObject Properties SequenceCallModule
OpenStatus ClassName (Read Only) AutoDeploySharedVariables LabVIEWParameter
CallFrontEndCallbackEx
SerializeObjects
SetConfigDirectory
This class has no methods.
Continued, next column Path CreateNewUniqueStepIds Properties
Methods This class has no properties. ActiveXModule ClassNameForNextCall (Read Only) AutoUndeploySharedVariables Properties
This class has no methods.
CanCreateStep Protection DeleteStep CodeModuleSeqFilePath Methods IsPrototypeIncompatible (Read Only) CodeTemplatePolicy Properties
CheckExpression
SetInternalOption
SetLocationForNextDialog
SelectedBreakpointItem WatchExpressions Requirements (Read Only) EvalEntryPointEnabledExpressionEx DisplayName GetBooleanValue
PropertyObject
MemberFlags (Read Only) CurrentLabVIEWServerVersion (Read Only) ArrayDimensions (Read Only)
CPUAffinityForNewThreadOption
CustomCPUAffinityForNewThread
CheckExprSyntax
SetProductRegistrationInfo Properties TypeUsageList (Read Only) EvalEntryPointNameExpressionEx FileExists (Read Only) AnalysisUtilities GetNumberValue Module MemberHelpString (Read Only) IsCurrentLabVIEWServerAnEditor (Read Only) ArrayElementPrototype (Read Only)
IgnoreTermination
ClearFilePasswordCache
SetTypePaletteFileList SequenceFile (Read Only) WatchExpression Version GetBreakOnEndSettings IsCodeModule (Read Only)
Property
GetStringValue ActiveXModule MemberName (Read Only) NumberOfThreadsUsedWhenExecutingVIsWithRTE Category (Read Only)
InitiallySuspended
CommitGlobalsToDisk SequenceName (Read Only) GetEffectiveType LastSourceControlMessages (Read Only) MemberType (Read Only) ReserveLoadedVIsForExec ComplexImaginaryPartElement (Read Only)
ShouldAutoLaunchExternalReportViewer Properties Methods AutomaticPropertyCheckingEnabled MultithreadingAndRemoteExecOption
CopyPropertyObject StepGroup (Read Only) GetEntryPointMenuFromHint NumContainedObjects (Read Only) Properties Parameters (Read Only) UseMultipleThreadsWhenExecutingVIsWithRTE ComplexRealPartElement (Read Only)
ShutDown BreakpointType AsPropertyObject NewExecutionBreakOnEntryExpr
CreateNewUniqueStepIds StepId (Read Only) GetNumSteps ObjectType (Read Only) Methods ActiveXReferenceExpr Signature (Read Only) UUTIterationNumberExpression DefaultValue (Read Only)
TerminateAll ClientSequenceFile CheckForModifiedTypes NewExecutionModelOption
CreateTempFile GetStep Path ValidateExpression CoClassName UnmappedArgumentValues (Read Only) UUTSerialNumberExpression Direction (Read Only)
UnloadAllModules ExecutionScope NewExecutionModelPath
Editing Classes
CurrentUserHasPrivilege Method HandleTypeConflicts GetStepByName DisplayType (Read Only)
UnloadTypePaletteFiles Expression ProjectFile (Read Only) ValidatePath CreateOption NewExecutionTypeMask
DelocalizeExpression IsEndSelected IncChangeCount GetStepByUniqueId Methods Methods Elements (Read Only)
UnregisterModalWindow NumericFormat SourceControlStatus (Read Only) ValidateRemoteHost FilePath NewExecutionTypeMaskExpr
DisplayAdapterConfigDialog Lock GetStepIndex CreateCode AsAdapter IsNodeUsingDefault
UnserializeObjects SequenceFileScope InterfaceName NewExecutionWaitForCompletion
DisplayBreakpointDialog ReadFile InsertStep Methods EditCode CheckRemoteSystemStatus ParameterCaption (Read Only)
DisplayBrowseExprDialogEx
UnserializeObjectsAndTypes StationOptions SequenceScope SaveFileIfModified LoadModules AsPropertyObject
MemberName
MemberType
GetAssembly DeployProjectLibrary ParameterName (Read Only)
NewThreadOptions
UserNameExists UniqueWatchId (Read Only) Unlock CanDoSourceControlCommand GetAssemblyForNextCall DisplayHelpForNodeProperty ParameterPrototype (Read Only)
DisplayBrowsePropertyObjectDialog Properties RemoveStep Parameters (Read Only) PartiallySpecified (Read Only)
WriteToolMenuToDisk UseScopingContext Use the editing-related classes to implement an undo/redo and a WriteFile DoSourceControlCommand IsCallValid FileExistsInLLB Parameters (Read Only)
DisplayConfigureTypePalettesDialog AllowAllUsersAccessFromRemoteMachine SetBreakOnEndSettings RemoteHost PassAsBinaryString
GetAbsolutePath LoadPrototypeFromSignature GetClassesForNodeLibrary RemoteHost
DisplayEditBreakAndWatchDialog Event AllowAutomaticTypeConflictResolution Methods goto location feature in a user interface. StepNameExists ServerId Type (Read Only)
GetContainedObject ReloadPrototype GetClusterMemberIsBinaryString SequenceFilePath
DisplayEditPathsInFilesDialog UIMessageEvent UnloadModules TypeDisplayString (Read Only)
DisplayEditUserDialog
AllowCancellingPreloadExpression
AllowOtherModels
BreakpointTriggered
DisplayConfigurationDialog
ResultLog GetParentContainer
SpecifyHostByExpression
UseStepLoadOptions
SetIncompleteSignature GetClusterMemberLabel UseDefaultValue
SequenceName
BeginEditEx
DisplayExpressionEditOptionsDialog AllowSequenceCallsFromRemoteMachine Evaluate Locations PropertyObject InsertCodeModules GetClusterPassingEnabled UserData (Read Only)
SpecifyByExpression
CreateAndPostUndoItem SequenceFile InsertObject Methods GetExcludeFromCluster ValidEvaluationTypes (Read Only)
SpecifyHostByExpression
DisplayExternalViewerDialog AlwaysGotoCleanupOnFailure GetScopingContext
Location EndBatchEdit DotNetModule StoreActiveXReferenceExpr
Search Classes
DisplayFileDialog AutoLoginSystemUser ResultLog NewFile AsModule GetExpressVIMenuStructure ValueExpr
EndEdit PropertyObject NewFolder TraceSetting
DisplayHelpFile BreakOnSequenceFailure Properties ReloadServer PropertyObject GetMemberNames ValueExprIsIgnored (Read Only)
Properties SequenceFile RemoveObject GetNodeLibraries ValueExprIsOptional (Read Only)
UseCurrentFile
DisplayHelpTopic BreakOnStepFailure AttributesPath ClosedWhenWritten (Read Only) UseSequenceParameterPrototype
DisplayLockUnlockDialog BreakpointsEnabled BaseAttributesPath UndoItems OnTheFly (Read Only) Properties
UpdateStatus
ActiveXParameters
Module GetPropertiesForLabVIEWClass
GetPropertiesForNodeClass
WireRequirement (Read Only)
DisplayLoginDialog CheckOutFilesWhenEdited ContextID DotNetModule Methods
UndoItem2 Path (Read Only) BatchSyncOption Methods
Element SecondsAtStartIn1970UniversalCoordinatedTime (Read Only) CanUnload (Read Only) Use the search-related classes to search files and property ActiveXParameter GetServerInfo
GetVINamespace AsPropertyObject
AsModule
Continued, next column Continued, next column ExecutionDisplayName Properties Properties LoadPrototypeFromSequence
UniqueId (Read Only) ChangeCount (Read Only) CreateDefaultArrayElements
ExecutionId LookupStrings (Read Only) objects in TestStand. When you call the PropertyObject. PropertyObject AssemblyWarnings (Read Only) GetVIVersion
DeleteArrayElement
Methods FileGlobalsDefaultValues (Read Only) Calls (Read Only) Initialize
FileDisplayName TopObjects (Read Only)
Close FileGlobalsScope Search or Engine.SearchFiles methods, TestStand returns ActiveXParameter
ClassHelpString (Read Only) IsExpressVI DeleteArrayElements SequenceCallParameters
FileId DisplayCreateCustomDataTypeDialog
FilePath Methods GetReportPaths HasModel (Read Only) a SearchResults object, which contains a list of SearchMatch Properties ClassName NewModule
ExprClusterTypeMismatch SequenceCallParameter
Legend This class has no methods. Id (Read Only) IsStruct SetClusterMemberIsBinaryString
Kind Open
IsExecuting (Read Only) objects. Use the SearchMatch class to identify the type and DefaultValue (Read Only)
SetClusterMemberLabel GetArrayIndex
PropertyPath NOTE The UndoItem2 class also inherits ReadNextRecord Direction (Read Only) ProjectFilePath PropertyObject
PropertyPathWithNames the properties and methods of the UndoItem SetReportPaths ModelOption location of a match and to perform Replace operations. DisplayType (Read Only) SolutionFilePath SetClusterPassingEnabled GetDefaultArrayDimensionSize
ModelPath SetExcludeFromCluster GetEnumValues SequenceCallParameter
SelLength class. Refer to the NI TestStand Help for EnumTypeName (Read Only) SourceFilePath
ModuleLoadOption SetServerInfo InsertArrayElement
Object A programmable software component that represents an Class Denotes a class that has a corresponding collection class.
SelStart more information about the properties and
ModuleUnloadOption SearchMatch SearchResults IsOptional (Read Only) UseStepLoadOptions
IsClusterMappingInvalid Properties
Collection SequenceName methods of the UndoItem class. ParameterName (Read Only) Methods UpdateClusterMapping ArgumentObject (Read Only)
NumSequences (Read Only) Properties Properties
instance of a class. You interact with the object using the
methods, properties, and events the class defines.
Class The top (lighter) text represents the collection. The lower
(darker) text represents the type of object the collection
StepGroup
StepId
Path FileDisplayName (Read Only) NumMatches (Read Only)
Type (Read Only)
UseDefault
AsModule LabVIEWArguments Name (Read Only)
DisplayCreateCustomDataTypeDialog PassByReference (Read Only)
contains. Collection class properties and methods are not listed StepIndex UndoStack SequenceFileType
UnloadCallbackEnabled
FileId (Read Only) NumWarnings (Read Only) UserData (Read Only) Execute LabVIEWArgument LabVIEWParameterElements PropertyObjectType (Read Only)
on this poster. StepName FilePath (Read Only) StatusMessage (Read Only) ValidEvaluationTypes (Read Only) GetAssembly TypeDisplayString (Read Only)
Property A value that stores and maintains a setting or attribute of
an object. ThreadDisplayName
Properties
CanRedo (Read Only) Methods MatchedText (Read Only)
Methods ValueExpr NewModuleArguments
Properties LabVIEWParameterElement UseDefaultValue
ThreadId MatchIsValid (Read Only) ComplexImaginaryPart (Read Only)
PropertyObject
Denotes inheritance or the classes from which the class CanUndo (Read Only) AddLoadReference Cancel ValueExprIsIgnored (Read Only) SetAssembly PropertyObject UserData (Read Only)
TypeCategory PropertyValueAsString (Read Only) ComplexRealPart (Read Only)
can inherit. RedoItems (Read Only) AsPropertyObject GetMatch ValueExprIsOptional (Read Only) ValidEvaluationTypes (Read Only)
(Read Only) Properties you can read but not change. InteractiveContext TypeName PropertyValueType (Read Only) Elements (Read Only)
UndoItems (Read Only) AsPropertyObjectFile GetWarning LabVIEWParameterElement ValueExpr
Methods
Methods CreateCallbackOverrideSequence TypeCategoryOfMatch (Read Only)
UserData
IsComplete AsPropertyObject
DotNetParameters ParameterName (Read Only)
Value Properties Methods
Indicates a grouping of classes commonly used together. Methods DeleteSequence
Method Performs an operation or function on an object. This class has no methods. AggregateTopUndoItems GetModelAbsolutePath Methods
GetEnumValues DotNetParameter Methods ArrayDimensions (Read Only) This class has no methods.
Clear GetModelCallbackNames This class has no methods. ArrayElementPrototype (Read Only)
Event Method an object invokes to inform a client application of a GetLocation PropertyObject Category (Read Only)
status or state change. UndoItemCreator GetRedoDescription
GetUndoDescription
GetModelSequenceFile GetPropertyPath
ComplexImaginaryPartElement (Read Only)
GetReservedCallbackNames UpdateForReplace DotNetParameter
Property Push GetSequence ComplexRealPartElement (Read Only)
UpdateForReplaceValue
Collection An object that contains zero or more objects of the same class. HaveEditsBeenMade (Read Only) Redo GetSequenceByName Properties DefaultValue (Read Only)
Undo GetSequenceIndex ArrayDimensionsEx (Read Only) Direction (Read Only)
Methods
BeginBatchEdit InsertSequenceEx Continued, next column Continued, next column
Continued, next column Continued, next column