SerialPort.ReadTimeout Eigenschaft

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Paket:

System.IO.Ports v11.0.0-preview.2.26159.112

Quelle:

SerialPort.cs

Ruft die Anzahl von Millisekunden ab, bevor ein Timeout auftritt, wenn ein Lesevorgang nicht beendet wird, oder legt diese fest.

public:
 property int ReadTimeout { int get(); void set(int value); };

public int ReadTimeout { get; set; }

member this.ReadTimeout : int with get, set

Public Property ReadTimeout As Integer

Eigenschaftswert

Int32

Die Anzahl der Millisekunden, bevor ein Timeout auftritt, wenn ein Lesevorgang nicht beendet wird.

Ausnahmen

IOException

Der Port befindet sich in einem ungültigen Zustand.

- oder -

Fehler beim Versuch, den Status des zugrunde liegenden Ports festzulegen. Die parameter, die von diesem SerialPort Objekt übergeben wurden, waren beispielsweise ungültig.

ArgumentOutOfRangeException

Der Wert für das Lesetimeout ist kleiner als Null und nicht gleich InfiniteTimeout.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der SerialPort Klasse veranschaulicht, um zwei Benutzern das Chatten von zwei separaten Computern zu ermöglichen, die über ein NULL-Modemkabel verbunden sind. In diesem Beispiel werden die Benutzer vor dem Chatten zur Eingabe der Porteinstellungen und eines Benutzernamens aufgefordert. Dieses Codebeispiel ist Teil eines größeren Codebeispiels, das für die SerialPort Klasse bereitgestellt wird.

public static void Main()
{
    string name;
    string message;
    StringComparer stringComparer = StringComparer.OrdinalIgnoreCase;
    Thread readThread = new Thread(Read);

    // Create a new SerialPort object with default settings.
    _serialPort = new SerialPort();

    // Allow the user to set the appropriate properties.
    _serialPort.PortName = SetPortName(_serialPort.PortName);
    _serialPort.BaudRate = SetPortBaudRate(_serialPort.BaudRate);
    _serialPort.Parity = SetPortParity(_serialPort.Parity);
    _serialPort.DataBits = SetPortDataBits(_serialPort.DataBits);
    _serialPort.StopBits = SetPortStopBits(_serialPort.StopBits);
    _serialPort.Handshake = SetPortHandshake(_serialPort.Handshake);

    // Set the read/write timeouts
    _serialPort.ReadTimeout = 500;
    _serialPort.WriteTimeout = 500;

    _serialPort.Open();
    _continue = true;
    readThread.Start();

    Console.Write("Name: ");
    name = Console.ReadLine();

    Console.WriteLine("Type QUIT to exit");

    while (_continue)
    {
        message = Console.ReadLine();

        if (stringComparer.Equals("quit", message))
        {
            _continue = false;
        }
        else
        {
            _serialPort.WriteLine(
                String.Format("<{0}>: {1}", name, message));
        }
    }

    readThread.Join();
    _serialPort.Close();
}

public static void Read()
{
    while (_continue)
    {
        try
        {
            string message = _serialPort.ReadLine();
            Console.WriteLine(message);
        }
        catch (TimeoutException) { }
    }
}

Public Shared Sub Main()
    Dim name As String
    Dim message As String
    Dim stringComparer__1 As StringComparer = StringComparer.OrdinalIgnoreCase
    Dim readThread As New Thread(AddressOf Read)

    ' Create a new SerialPort object with default settings.
    _serialPort = New SerialPort()

    ' Allow the user to set the appropriate properties.
    _serialPort.PortName = SetPortName(_serialPort.PortName)
    _serialPort.BaudRate = SetPortBaudRate(_serialPort.BaudRate)
    _serialPort.Parity = SetPortParity(_serialPort.Parity)
    _serialPort.DataBits = SetPortDataBits(_serialPort.DataBits)
    _serialPort.StopBits = SetPortStopBits(_serialPort.StopBits)
    _serialPort.Handshake = SetPortHandshake(_serialPort.Handshake)

    ' Set the read/write timeouts
    _serialPort.ReadTimeout = 500
    _serialPort.WriteTimeout = 500

    _serialPort.Open()
    _continue = True
    readThread.Start()

    Console.Write("Name: ")
    name = Console.ReadLine()

    Console.WriteLine("Type QUIT to exit")

    While _continue
        message = Console.ReadLine()

        If stringComparer__1.Equals("quit", message) Then
            _continue = False
        Else
            _serialPort.WriteLine([String].Format("<{0}>: {1}", name, message))
        End If
    End While

    readThread.Join()
    _serialPort.Close()
End Sub

Public Shared Sub Read()
    While _continue
        Try
            Dim message As String = _serialPort.ReadLine()
            Console.WriteLine(message)
        Catch generatedExceptionName As TimeoutException
        End Try
    End While
End Sub

Hinweise

Der Wert für das Lesetimeout wurde ursprünglich auf 500 Millisekunden in der Win32 Communications-API festgelegt. Mit dieser Eigenschaft können Sie diesen Wert festlegen. Das Timeout kann auf einen beliebigen Wert festgelegt werden, der größer als Null ist, oder auf InfiniteTimeout", in diesem Fall tritt kein Timeout auf. InfiniteTimeout ist die Standardoption.

Hinweis

Benutzer der nicht verwalteten COMMTIMEOUTS Struktur erwarten möglicherweise, dass der Timeoutwert auf Null festgelegt wird, um Timeouts zu unterdrücken. Um Timeouts mit der ReadTimeout Eigenschaft zu unterdrücken, müssen Sie jedoch angeben InfiniteTimeout.

Diese Eigenschaft wirkt sich nicht auf die BeginRead Methode des von der BaseStream Eigenschaft zurückgegebenen Datenstroms aus.