GetErrorStatus Method

Returns and clears the state of all incoming status lines.

Syntax

[Visual Basic]
object.GetErrorStatus ParityError, FramingError, OverrunError

[C#]
object.GetErrorStatus(Boolean &ParityError, Boolean &FramingError, Boolean &OverrunError)

[C++]
object->GetErrorStatus(Boolean &ParityError, Boolean &FramingError, Boolean &OverrunError)

Parameters

object

An object expression that evaluates to a PortController object.

ParityError

A boolean value that indicates if a parity error has occurred.

FramingError

A boolean value that indicates if a framing error has occurred.

OverrunError

A boolean value that indicates if a overrun error has occurred.

Return Value

A Char indicating the event character.

Remarks

Calling this method automatically clears any error state after the error information is returned.

Default

False

Errors

Calling the GetErrorStatus method while the port is closed is not permitted and will cause PortController to throw a "Port is closed" exception.

Example

[Visual Basic]
Dim ParityError As Boolean
Dim FramingError As Boolean
Dim OverrunError As Boolean

myPortController.GetErrorStatus ParityError, FramingError, OverrunError


[C#]
Boolean bParityError, bFramingError, bOverrunError;
myPortController.GetErrorStatus(out bParityError, out bFramingError, out bOverrunError);

[C++]
Boolean bParityError, bFramingError, bOverrunError;
myPortController->GetErrorStatus(&bParityError, &bFramingError, &bOverrunError);

See Also