SqlConnection.ConnectionTimeout 属性

定义

命名空间:

Microsoft.Data.SqlClient

程序集:

Microsoft.Data.SqlClient.dll

包:

Microsoft.Data.SqlClient v5.2.0

获取终止尝试并生成错误之前在尝试建立连接时所等待的时间。

public:
 virtual property int ConnectionTimeout { int get(); };

public override int ConnectionTimeout { get; }

member this.ConnectionTimeout : int

Public Overrides ReadOnly Property ConnectionTimeout As Integer

属性值

Int32

等待连接打开所需的时间（以秒为单位）。 默认值为 15 秒。

例外

ArgumentException

设置的值小于 0。

示例

以下示例创建 ， SqlConnection 并将 Connection Timeout 连接字符串中的 设置为 30 秒。 该代码将打开连接并在控制台窗口中显示 ConnectionTimeout 属性。

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        OpenSqlConnection();
        Console.ReadLine();
    }

    private static void OpenSqlConnection()
    {
        string connectionString = GetConnectionString();
        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            connection.Open();
            Console.WriteLine("State: {0}", connection.State);
            Console.WriteLine("ConnectionTimeout: {0}",
                connection.ConnectionTimeout);
        }
    }

    static private string GetConnectionString()
    {
        // To avoid storing the connection string in your code, 
        // you can retrieve it from a configuration file, using the 
        // System.Configuration.ConfigurationSettings.AppSettings property 
        return "Data Source=(local);Initial Catalog=AdventureWorks;"
            + "Integrated Security=SSPI;Connection Timeout=30";
    }
}

注解

可以使用连接字符串中的 或 Connection Timeout 关键字设置连接等待超时Connect Timeout的时间量。 值为 0 表示没有限制，应避免在 中 ConnectionString 执行连接，因为尝试连接会无限期等待。