SerialPort.ReadLine Metoda

Definice

Obor názvů:

System.IO.Ports

Sestavení:

System.IO.Ports.dll

Balíček:

System.IO.Ports v8.0.0

Zdroj:

SerialPort.cs

NewLine Načte hodnotu ve vstupní vyrovnávací paměti.

public:
 System::String ^ ReadLine();

public string ReadLine ();

member this.ReadLine : unit -> string

Public Function ReadLine () As String

Návraty

String

Obsah vstupní vyrovnávací paměti až do prvního výskytu NewLine hodnoty.

Výjimky

InvalidOperationException

Zadaný port není otevřený.

TimeoutException

Operace se nedokončila před vypršením časového limitu.

-nebo-

Nebyly přečteny žádné bajty.

Příklady

Následující příklad kódu ukazuje použití třídy povolit dvěma uživatelům chatovat ze dvou samostatných počítačů připojených SerialPort kabelem modemu s hodnotou null. Tento příklad kódu je součástí většího příkladu kódu, který je k dispozici pro SerialPort třídu.

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

Poznámky

Všimněte si, že zatímco tato metoda nevrací NewLine hodnotu, NewLine hodnota je odebrána ze vstupní vyrovnávací paměti.

Ve výchozím nastavení bude metoda blokovat, ReadLine dokud není řádek přijat. Pokud je toto chování nežádoucí, nastavte ReadTimeout vlastnost na libovolnou nenulovou hodnotu, aby metoda vynutila ReadLine vyvolání TimeoutException , pokud na portu není k dispozici řádek.

Pokud je potřeba přepínat mezi čtením textu a čtením binárních dat ze streamu, vyberte protokol, který pečlivě definuje hranici mezi textovými a binárními daty, například ruční čtení bajtů a dekódování dat.

Poznámka

Vzhledem k tomu, že SerialPort třída ukládání dat do vyrovnávací paměti a datový proud obsažený ve BaseStream vlastnosti ne, můžou tyto dvě třídy kolidovat o tom, kolik bajtů je k dispozici ke čtení. Vlastnost BytesToRead může znamenat, že existují bajty ke čtení, ale tyto bajty nemusí být přístupné pro datový proud obsažený ve BaseStream vlastnosti, protože byly do vyrovnávací paměti třídy SerialPort .