SerialPort.ErrorReceived Event

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Package:

System.IO.Ports v9.0.0-rc.2.24473.5

Source:

SerialPort.cs

Indicates that an error has occurred with a port represented by a SerialPort object.

public:
 event System::IO::Ports::SerialErrorReceivedEventHandler ^ ErrorReceived;

public event System.IO.Ports.SerialErrorReceivedEventHandler ErrorReceived;

member this.ErrorReceived : System.IO.Ports.SerialErrorReceivedEventHandler 

Public Custom Event ErrorReceived As SerialErrorReceivedEventHandler 

Event Type

SerialErrorReceivedEventHandler

Remarks

Error events can be caused by any of the items in the SerialError enumeration. Because the operating system determines whether to raise this event or not, not all parity errors may be reported.

PinChanged, DataReceived, and ErrorReceived events may be called out of order, and there may be a slight delay between when the underlying stream reports the error and when code can when the event handler is executed. Only one event handler can execute at a time.

If a parity error occurs on the trailing byte of a stream, an extra byte will be added to the input buffer with a value of 126.

The ErrorReceived event is raised on a secondary thread when an error is received from the SerialPort object. Because this event is raised on a secondary thread, and not the main thread, attempting to modify some elements in the main thread, such as UI elements, could raise a threading exception. If it is necessary to modify elements in the main Form or Control, post change requests back using Invoke, which will do the work on the proper thread.

For more information about handling events, see Handling and Raising Events.