SqlConnection.ConnectionTimeout プロパティ

.NET Framework クラス ライブラリ リファレンス

SqlConnection.ConnectionTimeout プロパティ

接続の確立の試行を開始してから、その試行を終了してエラーを生成するまでの待機時間を取得します。

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Overrides ReadOnly
 Property ConnectionTimeout As Integer

Visual Basic (使用法)

Dim instance As SqlConnection
Dim value As Integer

value = instance.ConnectionTimeout

C#

public override int ConnectionTimeout { get;
 }

C++

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

J#

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

JScript

public override function get
 ConnectionTimeout () : int

プロパティ値
接続確立の待機時間 (秒)。既定値は 15 秒です。

例外

例外の種類	条件
ArgumentException	設定値が 0 未満です。

解説

接続文字列の ConnectTimeout キーワードまたは Connection Timeout キーワードを使用して、接続がタイムアウトまで待機する時間を設定できます。0 は、制限なしを示します。ただし、接続の試行が永久的に待機されるため、ConnectionString では使用しないでください。

使用例

SqlConnection を作成し、接続文字列内で Connection Timeout を 30 秒に設定する例を次に示します。このコードは、接続を開き、コンソール ウィンドウに ConnectionTimeout プロパティを表示します。

Visual Basic

Private Sub OpenSqlConnection()
    Dim connectionString As String
 = GetConnectionString()
    Using connection As New SqlConnection(connectionString)
        connection.Open()

        Console.WriteLine("State: {0}", connection.State)
        Console.WriteLine("ConnectionTimeout: {0}",
 connection.ConnectionTimeout)
    End Using
End Sub

Private Function GetConnectionString() As
 String
    ' 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);Database=AdventureWorks;"
 _
      & "Integrated Security=SSPI;Connection Timeout=30;"
End Function

C#

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";
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SqlConnection クラス
SqlConnection メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用