SerialPort.GetPortNames メソッド

定義

名前空間:

System.IO.Ports

アセンブリ:

System.IO.Ports.dll

パッケージ:

System.IO.Ports v11.0.0-rc.1.26425.128

ソース:

SerialPort.Windows.cs

現在のコンピューターのシリアル ポート名の配列を取得します。

public:
 static cli::array <System::String ^> ^ GetPortNames();

public static string[] GetPortNames();

static member GetPortNames : unit -> string[]

Public Shared Function GetPortNames () As String()

返品

String[]

現在のコンピューターのシリアル ポート名の配列。

例外

Win32Exception

シリアル ポート名を照会できませんでした。

例

次のコード例では、 GetPortNames メソッドを使用してシリアル ポート名をコンソールに表示します。

using System;
using System.IO.Ports;

namespace SerialPortExample
{
    class SerialPortExample
    {
        public static void Main()
        {
            // Get a list of serial port names.
            string[] ports = SerialPort.GetPortNames();

            Console.WriteLine("The following serial ports were found:");

            // Display each port name to the console.
            foreach(string port in ports)
            {
                Console.WriteLine(port);
            }

            Console.ReadLine();
        }
    }
}

' Insert this code into a new VB Console application project, and set the
' startup object to Sub Main.

Imports System.IO.Ports

Module SerialPortExample

    Sub Main()
        ' Get a list of serial port names.
        Dim ports As String() = SerialPort.GetPortNames()

        Console.WriteLine("The following serial ports were found:")

        ' Display each port name to the console.
        Dim port As String
        For Each port In ports
            Console.WriteLine(port)
        Next port

        Console.ReadLine()

    End Sub
End Module

注釈

GetPortNamesから返されるポート名の順序が指定されていません。

GetPortNamesメソッドを使用して、現在のコンピューターに対して有効なシリアル ポート名の一覧を照会します。 たとえば、このメソッドを使用して、COM1 と COM2 が現在のコンピューターの有効なシリアル ポートであるかどうかを判断できます。

ポート名は、システム レジストリから取得されます (例: HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\SERIALCOMM)。 レジストリに古いデータまたは正しくないデータが含まれている場合、 GetPortNames メソッドは正しくないデータを返します。