VeriStand .NET API Reference

IWorkspace2.DisconnectFromSystem Method

Disconnects the VeriStand Gateway from all connected targets.

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 DisconnectFromSystem ( _
	password As String, _
	undeploy_system_definition As Boolean _
) As Error
C#
Error DisconnectFromSystem(
	string password,
	bool undeploy_system_definition
)
Visual C++
Error^ DisconnectFromSystem(
	String^ password, 
	bool undeploy_system_definition
)

Parameters

password
Type: System.String
The password for the current connection, if the connection is locked.
undeploy_system_definition
Type: System.Boolean
Specifies whether to undeploy the system definition file before disconnecting. If you set this parameter to false (False in Visual Basic), the target(s) continue to to run the system definition after the VeriStand Gateway disconnects.

Return Value

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

See Also

Log in to get a better experience