Serial.ReceiveTerminated Method
Click or drag to resize

SerialReceiveTerminated Method

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.4.0.2624)
Syntax
public string ReceiveTerminated(
	string Terminator
)

Parameters

Terminator
Type: SystemString
The character string that indicates end of message

Return Value

Type: String
Received characters including the terminator string
Exceptions
ExceptionCondition
TimeoutExceptionThrown when a receive timeout occurs.
SerialPortInUseExceptionThrown when unable to acquire the serial port
NotConnectedExceptionThrown when this command is used before setting Connect = True
Remarks
If a timeout occurs, a TimeoutException is raised.
See Also