SqlConnectionStringBuilder.ConnectTimeout Property

 

Gets or sets the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.

Namespace:   System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

Public Property ConnectTimeout As Integer

Property Value

Type: System.Int32

The value of the ConnectTimeout property, or 15 seconds if no value has been supplied.

This property corresponds to the "Connect Timeout", "connection timeout", and "timeout" keys within the connection string.

When opening a connection to a Azure SQL Database, set the connection timeout to 30 seconds.

The following example first displays the contents of a connection string that does not specify the "Connect Timeout" value, sets the ConnectTimeout property, and then displays the new connection string.

Imports System.Data.SqlClient

Module Module1

    Sub Main()
        Try
            Dim connectString As String = _
             "Server=(local);Initial Catalog=AdventureWorks;" & _
             "Integrated Security=True"
            Dim builder As New SqlConnectionStringBuilder(connectString)
            Console.WriteLine("Original: " & builder.ConnectionString)
            Console.WriteLine("ConnectTimeout={0}", _
                builder.ConnectTimeout)
            builder.ConnectTimeout = 100
            Console.WriteLine("Modified: " & builder.ConnectionString)

            Console.WriteLine("Press any key to finish.")
            Console.ReadLine()

        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Sub

End Module

.NET Framework
Available since 2.0
Return to top
Show: