SerialPort.IsOpen Property (System.IO.Ports)

Switch View

IsOpen Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SerialPort..::.IsOpen Property

Gets a value indicating the open or closed status of the SerialPort object.

Namespace: System.IO.Ports
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(False)> _
Public ReadOnly Property IsOpen As Boolean

Visual Basic (Usage)

Dim instance As SerialPort
Dim value As Boolean

value = instance.IsOpen

[BrowsableAttribute(false)]
public bool IsOpen { get; }

Visual C++

[BrowsableAttribute(false)]
public:
property bool IsOpen {
    bool get ();
}

JScript

public function get IsOpen () : boolean

Property Value

Type: System..::.Boolean
true if the serial port is open; otherwise, false. The default is false.

Exceptions

Exception	Condition
ArgumentNullException	The IsOpen value passed is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The IsOpen value passed is an empty string ("").

Remarks

The IsOpen property tracks whether the port is open for use by the caller, not whether the port is open by any application on the machine.

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

SerialPort Class

SerialPort Members

System.IO.Ports Namespace