TestStand API Offline Documentation

Updated Apr 23, 2026

Reported In

Software

  • TestStand

Issue Details

  • Where can I find documentation for the TestStand API?
  • I am unable to use the internet to access the online TestStand API reference. Is there any local documentation on my PC?

Solution

The most up-to-date documentation can be found online in the TestStand Programming Reference Manual. However, if you don't have internet access, you can also have access to the offline documentation.

 

The offline help experience will depend on the version TestStand. Please review the option that corresponds to your version.

 

 

Legacy Help Experience - TestStand 2023 Q4 and earlier

 

  1. In TestStand, select Help > TestStand Help... or press Ctrl+F1 
  2. In the Help dialog that appears, expand the TestStand API Reference item of the Contents tree.
  3. Select the topic you want to review.

 

This is what the help window should look like.

 

 

Note: You can also find the help file at <TestStand>\Doc\Help\TSAPIRef.chm

 

 

New Help Experience - TestStand 2024 Q4 and later

 

In TestStand 2024 Q4 and later, help links open the online TestStand documentation in the NI Documentation Portal (ni.com/docs) when an internet connection is available.

 

If your system is not connected to the internet, help links open the NI Offline Help Viewer, which is installed with TestStand, to provide access to locally available help documentation. You can also launch TestStand help directly from the NI Offline Help Viewer without opening TestStand.

 

To open the offline help. Follow these steps:

 

  1. In TestStand, select Help > TestStand Help... or press Ctrl+F1. If you are offline, the NI Offline Help Viewer will launch.
  2. Navigate through the list of manuals or use the search tool to find the TestStand API Reference.

 

This is what the help window should look like.

 

 

Notes:

  • Use the NI Help Preferences application to configure whether NI product help opens using online documentation or the offline help viewer by default.
  • Starting in TestStand 2024 Q4, TestStand no longer includes offline help documentation provided in Microsoft Compiled HTML Help (.chm) format.

Additional Information

The contents of the API help are sorted by:

 

  • API Classes, Properties and Methods
  • API Constants
  • API Enumerations

 

You can search for a specific method or property in the Search tab, as shown below.


Legacy ExperienceNew Experience
Search API.PNG