CommandLineArguments Property (Read Only)

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

Syntax

ApplicationMgr.CommandLineArguments

Data Type

Strings

Purpose

Returns the collection of command-line arguments to the application. The following are switches on the command line:

  • /run <sequence> <sequencefile>—Runs the sequence in the sequence file.
  • /runEntryPoint <entryPointName> <SequenceFile>—Runs the entry point on the sequence file.
  • /quit—Exits the application once all executions complete.
  • /setCurrentDir—Sets the current directory to the first directory in the directory history list in the File dialog box. The current directory is the directory the File dialog box initially displays when you open a file. Use this option to set the directory the File dialog box displays to the directory the File dialog box displayed the last time you ran the application. The application sets the current directory after processing the other command-line options.
  • /?—Launches a help dialog box, which contains a list of valid command-line arguments, and then immediately closes.
  • /useExisting—Prevents a second instance of the application from running and forwards all command-line arguments to the application that is already running.
  • /goto <location>—Instructs the application to display the item the <location> property object path specifies, such as
    TestExec.exe C:\example.seq /goto "Seq[\"MainSequence\"].Main[\"Power On\"]"

    TestExec.exe C:\example.seq /goto "Seq[\"MainSequence\"].Main[\"ID#:JifH4ODTf0y1z7bJne0G7D\"]"

    TestExec.exe C:\example.seq /goto "Seq[1].Main[4].TS.LoadOpt"
  • /editor—Enables the application to create and edit sequence files. You must have activated a license that supports creating and editing sequence files.
  • /operatorInterface—Prevents the application from creating and editing sequence files.
    Note  You can use / or - to specify a switch. Quotation marks are required for arguments that contain a space, such as "Test UUTs" and "C:\My Documents\Test Sequence.seq".

Remarks

The collection is created by splitting up the command line used to start the application, using white space as a delimiter.

Note  When you launch another instance of the application with the /useExisting command-line switch, this property does not change to reflect the arguments forwarded to the application. Use the ApplicationMgr.ProcessUserCommandLineArguments event instead to process command-line arguments from another instance of the application.


See Also

ApplicationMgr.ProcessCommandLine

ApplicationMgr.ProcessUserCommandLineArguments

TestStand Licensing Options

WAS THIS ARTICLE HELPFUL?

Not Helpful