Share via


ConnectionSettings.ConnectTimeout Property

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 
    Get 
    Set
'Usage
Dim instance As ConnectionSettings 
Dim value As Integer 

value = instance.ConnectTimeout

instance.ConnectTimeout = value
public int ConnectTimeout { get; set; }
public:
property int ConnectTimeout {
    int get ();
    void set (int value);
}
member ConnectTimeout : int with get, set
function get ConnectTimeout () : int 
function set ConnectTimeout (value : int)

Property Value

Type: System.Int32
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.

Examples

'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 = "AdventureWorks2012"
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)

See Also

Reference

ConnectionSettings Class

Microsoft.SqlServer.Management.Common Namespace

Other Resources

Connecting to an Instance of SQL Server