Receive characters from the ASCOM serial port until the given terminator string is seen

Namespace: ASCOM.Utilities
Assembly: ASCOM.Utilities (in ASCOM.Utilities.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
public string ReceiveTerminated(
	string Terminator
)
Visual Basic
Public Function ReceiveTerminated ( _
	Terminator As String _
) As String
Visual C++
public:
virtual String^ ReceiveTerminated(
	String^ Terminator
) sealed

Parameters

Terminator
Type: System..::..String
The character string that indicates end of message

Return Value

Received characters including the terminator string

Implements

ISerial..::..ReceiveTerminated(String)

Remarks

If a timeout occurs, a TimeoutException is raised.

Exceptions

ExceptionCondition
System..::..TimeoutExceptionThrown when a receive timeout occurs.
ASCOM.Utilities.Exceptions..::..SerialPortInUseExceptionThrown when unable to acquire the serial port
ASCOM..::..NotConnectedExceptionThrown when this command is used before setting Connect = True

See Also