IWorkspace.RunWorkspaceFile Method
- Updated2023-02-21
- 3 minute(s) read
This method is deprecated in NI VeriStand 2010 and later. Use the ConnectToSystem method instead.
Namespace:
NationalInstruments.VeriStand.ClientAPIRuns the workspace configuration you specify. If a configuration is already running when you call this method, the method returns an error.
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
| Visual Basic (Declaration) |
|---|
Function RunWorkspaceFile ( _ file_path As String, _ launchworkspace As Boolean, _ deploysystemdefinition As Boolean, _ timeout As UInteger, _ user_name As String, _ password As String _ ) As Error |
| C# |
|---|
Error RunWorkspaceFile( string file_path, bool launchworkspace, bool deploysystemdefinition, uint timeout, string user_name, string password ) |
| Visual C++ |
|---|
Error^ RunWorkspaceFile( String^ file_path, bool launchworkspace, bool deploysystemdefinition, unsigned int timeout, String^ user_name, String^ password ) |
Parameters
- file_path
- Type: System.String
The path to the configuration.
- launchworkspace
- Type: System.Boolean
Specifies whether to launch the Workspace window. This input is ignored in NI VeriStand 2010 and later.
- deploysystemdefinition
- Type: System.Boolean
Specifies whether to deploy the system definition file before running the workspace.
- timeout
- Type: System.UInt32
The time allowed for the VeriStand Gateway to successfully deploy the system definition to the target(s) and for the target(s) to achieve active running state. If timeout is exceeded, deployment is cancelled.
- user_name
- Type: System.String
The user name to use to access the NI VeriStand project. This parameter is ignored in NI VeriStand 2010 and later.
- password
- Type: System.String
The password associated with the user_name you enter. This input is ignored in NI VeriStand 2010 and later.