C# SerialPort 類

來源:互聯網
上載者:User

SerialPort 類

表示序列埠資源

繼承階層

--------------------------------------------------------------------------------

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.IO.Ports.SerialPort

 

命名空間: System.IO.Ports
程式集: System(在 System.dll 中)

文法

--------------------------------------------------------------------------------

C#

public class SerialPort : Component
 
SerialPort 類型公開以下成員。

 

建構函式

--------------------------------------------------------------------------------
名稱

說明

 

 

SerialPort()

初始化 SerialPort 類的新執行個體。

SerialPort(IContainer)

使用指定的 IContainer 對象初始化 SerialPort 類的新執行個體。

SerialPort(String)

使用指定的連接埠名稱初始化 SerialPort 類的新執行個體。

 

SerialPort(String, Int32)

使用指定的連接埠名稱和傳輸速率初始化 SerialPort 類的新執行個體。

 

SerialPort(String, Int32, Parity)

使用指定的連接埠名稱、傳輸速率和同位位元初始化 SerialPort 類的新執行個體。

 

SerialPort(String, Int32, Parity, Int32)

使用指定的連接埠名稱、傳輸速率、校正位和資料位元初始化 SerialPort 類的新執行個體。

 

SerialPort(String, Int32, Parity, Int32, StopBits)

使用指定的連接埠名稱、傳輸速率、同位位元、資料位元和停止位初始化 SerialPort 類的新執行個體。

屬性

--------------------------------------------------------------------------------

名稱  說明

  

BaseStream

擷取 SerialPort 對象的基礎 Stream 對象。

BaudRate

擷取或設定串列傳輸速率。

 
BreakState

 擷取或設定中斷訊號狀態。

  

BytesToRead

擷取接收緩衝區中資料的位元組數。

  

BytesToWrite

 擷取發送緩衝區中資料的位元組數。

  

CanRaiseEvents

 擷取一個指示組件是否可以引發事件的值。
(繼承自 Component。)

  

CDHolding

擷取連接埠的偵測載波行的狀態。

Container

擷取 IContainer,它包含 Component。
(繼承自 Component。)

 

CtsHolding

 擷取“可以發送”行的狀態。

DataBits

擷取或設定每個位元組的標準資料位元長度。

 

DesignMode

擷取一個值,用以指示 Component 當前是否處於設計模式。 (繼承自 Component。)

 

DiscardNull

擷取或設定一個值,該值指示 Null 位元組在連接埠和接收緩衝區之間傳輸時是否被忽略。

  

DsrHolding

 擷取資料設定就緒 (DSR) 訊號的狀態。

 

 DtrEnable

擷取或設定一個值,該值在串列通訊過程中啟用資料終端機就緒 (DTR) 訊號。

 

 Encoding

取或設定傳輸前後文本轉換的位元組編碼。

 

 Events

擷取附加到此 Component 的事件處理常式的列表。 (繼承自 Component。)

 

 Handshake

擷取或設定序列埠資料轉送的握手協議。

 

 IsOpen

擷取一個值,該值指示 SerialPort 對象的開啟或關閉狀態。

 

 NewLine

擷取或設定用於解釋 ReadLine 和 WriteLine 方法調用結束的值。

 

 Parity

擷取或設定同位檢查協議。

 

 ParityReplace

擷取或設定一個位元組,該位元組在發生同位錯誤時替換資料流中的無效位元組。

 

 PortName

擷取或設定通訊連接埠,包括但不限於所有可用的 COM 連接埠。

 

 ReadBufferSize

擷取或設定 SerialPort 輸入緩衝區的大小。

 

 ReadTimeout 擷取或設定讀取操作未完成時發生逾時之前的毫秒數。

 

 ReceivedBytesThreshold

擷取或設定 DataReceived 事件發生前內部輸入緩衝區中的位元組數。

 

 RtsEnable

擷取或設定一個值,該值指示在串列通訊中是否啟用請求發送 (RTS) 訊號。

 

 Site

擷取或設定 Component 的 ISite。 (繼承自 Component。)

 

 StopBits

擷取或設定每個位元組的標準停止位元。

 

 WriteBufferSize

擷取或設定序列埠輸出緩衝區的大小。

 WriteTimeout

 擷取或設定寫入操作未完成時發生逾時之前的毫秒數。

方法

--------------------------------------------------------------------------------

名稱 說明

  

Close

關閉連接埠串連,將 IsOpen 屬性設定為 false,並釋放內部 Stream 對象。

 

CreateObjRef

 建立一個對象,該對象包含產生用於與遠程對象進行通訊的代理所需的全部相關資訊。 (繼承自 MarshalByRefObject。)

 

DiscardInBuffer

丟棄來自串列驅動程式的接收緩衝區的資料。

 

DiscardOutBuffer

 棄來自串列驅動程式的傳輸緩衝區的資料。

 

Dispose()

放由 Component 使用的所有資源。 (繼承自 Component。)

 

Dispose(Boolean)

放由 SerialPort 佔用的非託管資源,還可以另外再釋放託管資源。 (重寫 Component.Dispose(Boolean)。)

 

Equals(Object)

定指定的對象是否等於當前對象。 (繼承自 Object。)

 

Finalize

通過記憶體回收將 Component 回收之前,釋放非託管資源並執行其他清理操作。 (繼承自 Component。)

 

GetHashCode

作特定類型的雜湊函數。 (繼承自 Object。)

 

GetLifetimeService

索控制此執行個體的生存期策略的當前生存期服務物件。 (繼承自 MarshalByRefObject。)

 

GetPortNames

取當前電腦的序列埠名稱數組。

 

GetService

回一個對象,該對象表示由 Component 或它的 Container 提供的服務。 (繼承自 Component。)

 

GetType

取當前執行個體的 Type。 (繼承自 Object。)

 

InitializeLifetimeService

取控制此執行個體的生存期策略的生存期服務物件。 (繼承自 MarshalByRefObject。)

 

MemberwiseClone()

 建當前 Object 的淺表副本。 (繼承自 Object。)

 

MemberwiseClone(Boolean)

建當前 MarshalByRefObject 對象的淺表副本。 (繼承自 MarshalByRefObject。)

 

Open

開一個新的序列埠串連。

 

Read(Byte[], Int32, Int32)

SerialPort 輸入緩衝區讀取一些位元組並將那些位元組寫入位元組數組中指定的位移量處。

 

Read(Char[], Int32, Int32)

SerialPort 輸入緩衝區中讀取大量字元,然後將這些字元寫入到一個字元數組中指定的位移量處。

 

ReadByte

 從 SerialPort 輸入緩衝區中同步讀取一個位元組。

 

ReadChar

 SerialPort 輸入緩衝區中同步讀取一個字元。

 

ReadExisting

編碼的基礎上,讀取 SerialPort 對象的流和輸入緩衝區中所有立即可用的位元組。

 

ReadLine

直讀取到輸入緩衝區中的 NewLine 值。

 

ReadTo

直讀取到輸入緩衝區中的指定 value 的字串。

 

ToString

返回包含 Component 的名稱的 String(如果有)。不應重寫此方法。 (繼承自 Component。)

 

Write(String)

將指定的字串寫入序列埠。

 

Write(Byte[], Int32, Int32)

用緩衝區的資料將指定數量的位元組寫入序列埠。

 

Write(Char[], Int32, Int32)

 用緩衝區的資料將指定數量的字元寫入序列埠。

 

WriteLine

指定的字串和 NewLine 值寫入輸出緩衝區。

事件

--------------------------------------------------------------------------------

名稱 說明

  

DataReceived

表示將處理 SerialPort 對象的資料接收事件的方法。

  

Disposed

當通過調用 Dispose 方法釋放組件時發生。 (繼承自 Component。)

 

ErrorReceived

表示處理 SerialPort 對象的錯誤事件的方法。

 

PinChanged

表示將處理 SerialPort 對象的串列管腳變更事件的方法。

欄位

--------------------------------------------------------------------------------

名稱 說明

 

InfiniteTimeout

指示不應該發生逾時。

備忘

--------------------------------------------------------------------------------

 

此類用於控制序列埠檔案資源。此類提供同步 I/O 和事件驅動的 I/O、對管腳和中斷狀態的訪問以及對串列驅動程式屬性的訪問。另外,此類的功能可以封裝在內部 Stream 對象中,可通過 BaseStream 屬性訪問,並且可以傳遞給封裝或使用流的類。

SerialPort 類支援以下編碼:ASCIIEncoding、UTF8Encoding、UnicodeEncoding、UTF32Encoding,以及 mscorlib.dll 中定義的、字碼頁小於 50000 或者為 54936 的所有編碼。可以使用備用編碼,但必須使用 ReadByte 或 Write 方法並自己執行編碼。

使用 GetPortNames 方法檢索當前電腦的有效連接埠。

如果 SerialPort 對象被阻止在一次讀取操作時,不要中止線程。相反,或者關閉基礎流或進程 SerialPort 對象。

 

樣本

--------------------------------------------------------------------------------

 

下面的程式碼範例示範如何使用 SerialPort 類以允許兩位使用者分別在兩台通過 NULL 數據機電纜連線的獨立電腦上聊天。本樣本中,在聊天之前將提示使用者輸入連接埠設定和使用者名稱。這兩台電腦必須同時執行該程式才能實現本樣本的全部功能。

C#

 

using System;
using System.IO.Ports;
using System.Threading;

public class PortChat
{
    static bool _continue;
    static SerialPort _serialPort;

    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 static string SetPortName(string defaultPortName)
    {
        string portName;

        Console.WriteLine("Available Ports:");
        foreach (string s in SerialPort.GetPortNames())
        {
            Console.WriteLine("   {0}", s);
        }

        Console.Write("COM port({0}): ", defaultPortName);
        portName = Console.ReadLine();

        if (portName == "")
        {
            portName = defaultPortName;
        }
        return portName;
    }

    public static int SetPortBaudRate(int defaultPortBaudRate)
    {
        string baudRate;

        Console.Write("Baud Rate({0}): ", defaultPortBaudRate);
        baudRate = Console.ReadLine();

        if (baudRate == "")
        {
            baudRate = defaultPortBaudRate.ToString();
        }

        return int.Parse(baudRate);
    }

    public static Parity SetPortParity(Parity defaultPortParity)
    {
        string parity;

        Console.WriteLine("Available Parity options:");
        foreach (string s in Enum.GetNames(typeof(Parity)))
        {
            Console.WriteLine("   {0}", s);
        }

        Console.Write("Parity({0}):", defaultPortParity.ToString());
        parity = Console.ReadLine();

        if (parity == "")
        {
            parity = defaultPortParity.ToString();
        }

        return (Parity)Enum.Parse(typeof(Parity), parity);
    }

    public static int SetPortDataBits(int defaultPortDataBits)
    {
        string dataBits;

        Console.Write("Data Bits({0}): ", defaultPortDataBits);
        dataBits = Console.ReadLine();

        if (dataBits == "")
        {
            dataBits = defaultPortDataBits.ToString();
        }

        return int.Parse(dataBits);
    }

    public static StopBits SetPortStopBits(StopBits defaultPortStopBits)
    {
        string stopBits;

        Console.WriteLine("Available Stop Bits options:");
        foreach (string s in Enum.GetNames(typeof(StopBits)))
        {
            Console.WriteLine("   {0}", s);
        }

        Console.Write("Stop Bits({0}):", defaultPortStopBits.ToString());
        stopBits = Console.ReadLine();

        if (stopBits == "")
        {
            stopBits = defaultPortStopBits.ToString();
        }

        return (StopBits)Enum.Parse(typeof(StopBits), stopBits);
    }

    public static Handshake SetPortHandshake(Handshake defaultPortHandshake)
    {
        string handshake;

        Console.WriteLine("Available Handshake options:");
        foreach (string s in Enum.GetNames(typeof(Handshake)))
        {
            Console.WriteLine("   {0}", s);
        }

        Console.Write("Handshake({0}):", defaultPortHandshake.ToString());
        handshake = Console.ReadLine();

        if (handshake == "")
        {
            handshake = defaultPortHandshake.ToString();
        }

        return (Handshake)Enum.Parse(typeof(Handshake), handshake);
    }
}

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.