TcpClient.Active Property (System.Net.Sockets)

Microsoft Developer Network

Active Property

.NET Framework Class Library

TcpClient..::.Active Property

Gets or set a value that indicates whether a connection has been made.

Namespace: System.Net.Sockets
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

Protected Property Active As Boolean

Visual Basic (Usage)

Dim value As Boolean

value = Me.Active

Me.Active = value

protected bool Active { get; set; }

Visual C++

protected:
property bool Active {
    bool get ();
    void set (bool value);
}

JScript

protected function get Active () : boolean
protected function set Active (value : boolean)

Property Value

Type: System..::.Boolean
true if the connection has been made; otherwise, false.

Remarks

Classes deriving from TcpClient can use this property to determine if a connection attempt has succeeded. It does not monitor the ongoing connection state of TcpClient. If the remote host closes the connection, Active will not be updated. If you are deriving from TcpClient and require closer attention to the connection state, use the Connected property of the Socket returned by the Client method.

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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

TcpClient Class

TcpClient Members

System.Net.Sockets Namespace

Connected

Connect