SerialPort.GetPortNames メソッド

.NET Framework クラス ライブラリ リファレンス

SerialPort.GetPortNames メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.IO.Ports
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Shared Function GetPortNames
 As String()

Visual Basic (使用法)

Dim returnValue As String()

returnValue = SerialPort.GetPortNames

C#

public static string[] GetPortNames
 ()

C++

public:
static array<String^>^ GetPortNames ()

J#

public static String[] GetPortNames ()

JScript

public static function GetPortNames
 () : String[]

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

例外

例外の種類	条件
Win32Exception	シリアル ポート名を照会できませんでした。

解説

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

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

Windows 98 環境では、ポート名はシステム レジストリ (HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\SERIALCOMM) から取得されます。レジストリ内のデータが古い、または誤っている場合、GetPortNames メソッドは不正なデータを返します。

使用例

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

Visual Basic

Imports System
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

C#

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();
        }

    }
}

C++

#using <System.dll>

using namespace System;
using namespace System::IO::Ports;
using namespace System::ComponentModel;

void main()
{
    array<String^>^ serialPorts = nullptr;
    try
    {
        // Get a list of serial port names.
        serialPorts = SerialPort::GetPortNames();
    }
    catch (Win32Exception^ ex)
    {
        Console::WriteLine(ex->Message);
    }

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

    // Display each port name to the console.
    for each(String^ port in serialPorts)
    {
        Console::WriteLine(port);
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
SerialPort クラス
SerialPort メンバ
System.IO.Ports 名前空間