VeriStand .NET API Reference

Table of Contents
Table of Contents

IWorkspace.GetEngineState Method

Download PDF
Selected SectionSelected Section and Subsection(s)Entire Manual
This method is deprecated in NI VeriStand 2010 and later. Use the GetSystemState method instead.

Returns the current state of the VeriStand Engine.

Namespace: NationalInstruments.VeriStand.ClientAPI
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
Visual Basic (Declaration)
Function GetEngineState ( _
	<OutAttribute> ByRef state As SystemState, _
	<OutAttribute> ByRef workspace_file As String, _
	<OutAttribute> ByRef systemdefinition_file As String, _
	<OutAttribute> ByRef ip_address As String _
) As Error
C#
Error GetEngineState(
	out SystemState state,
	out string workspace_file,
	out string systemdefinition_file,
	out string ip_address
)
Visual C++
Error^ GetEngineState(
	[OutAttribute] SystemState% state, 
	[OutAttribute] String^% workspace_file, 
	[OutAttribute] String^% systemdefinition_file, 
	[OutAttribute] String^% ip_address
)

Parameters

state
Type: NationalInstruments.VeriStand.ClientAPI.SystemState %
The current SystemState of the VeriStand Engine.
workspace_file
Type: System.String %
The current system definition file. The workspace file does not exist in NI VeriStand 2010 and later.
systemdefinition_file
Type: System.String %
The current system definition file.
ip_address
Type: System.String %
The IP address of the system.

Return Value

Returns an Error object. If no error occurs, the Code property of the Error object is 0.

See Also

Previous

No previous section

Next

No next section

Previous

No previous section

Next

No next section

Log in to get a better experience

Log in