SerialPort.ReadLine Methode

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Paket:

System.IO.Ports v8.0.0

Quelle:

SerialPort.cs

Liest bis zum NewLine-Wert im Eingabepuffer.

public:
 System::String ^ ReadLine();

public string ReadLine ();

member this.ReadLine : unit -> string

Public Function ReadLine () As String

Gibt zurück

String

Der Inhalt des Eingabepuffers bis zum ersten Vorkommen eines NewLine-Werts.

Ausnahmen

InvalidOperationException

Der angegebene Anschluss ist nicht offen.

TimeoutException

Der Vorgang konnte nicht vor Ablauf des Timeouts abgeschlossen werden.

- oder -

Es wurden keine Bytes gelesen.

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung der SerialPort -Klasse, um zwei Benutzern das Chatten von zwei separaten Computern zu ermöglichen, die über ein NULL-Modemkabel verbunden sind. 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 = gcnew Thread(gcnew ThreadStart(PortChat::Read));

        // Create a new SerialPort object with default settings.
        _serialPort = gcnew 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();
    }

    static void Read()
    {
        while (_continue)
        {
            try
            {
                String^ message = _serialPort->ReadLine();
                Console::WriteLine(message);
            }
            catch (TimeoutException ^) { }
        }
    }

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

Beachten Sie, dass der Wert von dieser Methode zwar nicht zurückgegeben NewLine wird, der NewLine Wert jedoch aus dem Eingabepuffer entfernt wird.

Standardmäßig wird die ReadLine -Methode blockiert, bis eine Zeile empfangen wird. Wenn dieses Verhalten nicht erwünscht ist, legen Sie die ReadTimeout -Eigenschaft auf einen beliebigen Wert ungleich 0 fest, um zu erzwingen, dass die ReadLine Methode eine TimeoutException auslöst, wenn eine Zeile am Port nicht verfügbar ist.

Wenn zwischen dem Lesen von Text und dem Lesen von Binärdaten aus dem Stream gewechselt werden muss, wählen Sie ein Protokoll aus, das die Grenze zwischen Text- und Binärdaten sorgfältig definiert, z. B. manuelles Lesen von Bytes und Decodieren der Daten.

Hinweis

Da die SerialPort -Klasse Daten puffert und der in der BaseStream -Eigenschaft enthaltene Stream nicht, können die beiden in Konflikt stehen, wie viele Bytes zum Lesen verfügbar sind. Die BytesToRead -Eigenschaft kann angeben, dass Zu lesende Bytes vorhanden sind, aber diese Bytes sind möglicherweise nicht für den in der BaseStream -Eigenschaft enthaltenen Stream zugänglich, da sie in der SerialPort -Klasse gepuffert wurden.