ConnectionSettings.ConnectTimeout Property

Article
12/03/2008

Gets or sets the connection time-out period in seconds.

Namespace: Microsoft.SqlServer.Management.Common
Assembly: Microsoft.SqlServer.ConnectionInfo (in microsoft.sqlserver.connectioninfo.dll)

Syntax

'Declaration
Public Property ConnectTimeout As Integer

public int ConnectTimeout { get; set; }

public:
property int ConnectTimeout {
    int get ();
    void set (int value);
}

/** @property */
public int get_ConnectTimeout ()

/** @property */
public void set_ConnectTimeout (int value)

public function get ConnectTimeout () : int

public function set ConnectTimeout (value : int)

Property Value

An Int32 value that specifies the connection time-out period in seconds.

Remarks

If the time taken to establish a connection with the instance of the server exceeds the connection time-out period then the connection fails.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv1 As Server
srv1 = New Server()
'Modify the default database and the timeout period for the connection.
srv1.ConnectionContext.DatabaseName = "AdventureWorks"
srv1.ConnectionContext.ConnectTimeout = 30
'Make a second connection using a copy of the ConnectionContext property and verify settings.
Dim srv2 As Server
srv2 = New Server(srv1.ConnectionContext.Copy)
Console.WriteLine(srv2.ConnectionContext.ConnectTimeout.ToString)

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms