TestStand API Reference Help

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

This help file contains the following information:

  • Basic information about the TestStand ActiveX Automation server, API concepts, and writing applications with TestStand.
  • Detailed information about the properties, methods, events, constants, and enumerations of the TestStand API.

This help file assumes you have read and are familiar with the concepts presented in the NI TestStand System and Architecture Overview Card and the Getting Started with TestStand manual. Refer to the NI TestStand API Reference Poster for an illustration of API inheritance.

Using TestStand API Objects

SequenceContext InteractiveContext Report ReportSection ReportSections Execution Thread SequenceFile Engine UIMessage UsersFile WorkspaceFile WorkspaceObject PropertyObjectFile User TypeUsageList WatchExpressions WatchExpression Adapter ActiveXAdapter CommonCAdapter DotNetAdapter HTBasicAdapter LabVIEWAdapter SequenceAdapter CVIAdapter DllAdapter StepType Step Sequence Module SequenceCallModule SequenceCallParameters SequenceCallParameter LabVIEWModule LabVIEWParameters LabVIEWParameter LabVIEWParameterElements LabVIEWParameterElement HTBasicModule DotNetModule DotNetParameters DotNetParameter ActiveXModule ActiveXParameters ActiveXParameter CommonCModule CommonCParameter DllModule DllParameters DllParameter CVIModule CVIParameters CVIParameter StationOptions SearchDirectories SearchDirectory SearchResults SearchMatch ExternalReportViewers ExternalReportViewer Images EditTimeMenuItems EditTimeMenuItem RunTimeMenuItems RunTimeMenuItem EvaluationTypes EvaluationTypes FileInformation Locations Location OutputMessages OutputMessage SelectedBreakpointItem UndoItemCreator UndoItems UndoItem UndoStack Execution PropertyObjectFile Thread SequenceFile CodeTemplates CodeTemplate StepAdditionalResults AdditionalResults AdditionalResult Reports DotNetCalls DotNetCall PythonAdapter PythonModule PythonParameters PythonParameter

In the TestStand API, many objects reference other types of objects. You can obtain an object of one class from an object of another class by calling a method or accessing a property. For example, you can obtain the Engine, Thread, Execution, and Report objects from the SequenceContext object. In another example, a UIMessage object references an Execution object, and an Execution object references a SequenceFile object.

About This Figure

The following figure includes only existing objects. Color represents items that are duplicated. The figure does not include the following information:

  • Explanation of how to create new objects from the Engine object
  • PropertyObject objects that you can obtain from any object in the figure except an Engine object
  • Illustration of when you can acquire a reference to a derived class by querying for the derived interface
  • References from module type objects to Step objects

Click the classes in the following figure for more information about the class and a listing of the properties and methods associated with the class.

Additional Information

Note  If you open help files directly from the <TestStand>\Doc\Help directory, National Instruments recommends that you open TSHelp.chm first because this file is a collection of all the TestStand help files and provides a complete table of contents and index.

To navigate this help file, use the Contents, Index, and Search tabs to the left of this window.

Refer to the National Instruments website to comment on National Instruments documentation.

© 2003–2019 National Instruments. All rights reserved.


See Also

Engine

Execution

PropertyObject

Report

SequenceContext

SequenceFile

Step

Thread

TypeUsageList

UIMessage

WAS THIS ARTICLE HELPFUL?

Not Helpful