Share via


DataConnectionSupport.ConnectionTimeout Property

Retrieves or sets the amount of time, in seconds, to wait to establish a connection before terminating the attempt and generating a timeout error.

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public MustOverride Property ConnectionTimeout As Integer
public abstract int ConnectionTimeout { get; set; }
public:
virtual property int ConnectionTimeout {
    int get () abstract;
    void set (int value) abstract;
}
abstract ConnectionTimeout : int with get, set
abstract function get ConnectionTimeout () : int 
abstract function set ConnectionTimeout (value : int)

Property Value

Type: System.Int32
Returns an integer representation of the allowable timeout period, in seconds.

Exceptions

Exception Condition
NotSupportedException

The provider does not support connection timeout.

Remarks

The default value depends on the data provider. A value of zero indicates there is no timeout, meaning the data provider will wait indefinitely, or until something other than the data provider causes it to timeout, as with a TCP/IP timeout. The value -1 indicates that timeouts are not supported by the provider.

Note

If the provider does not support timeouts, a NotSupportedException should be thrown when trying to set it.

.NET Framework Security

See Also

Reference

DataConnectionSupport Class

Microsoft.VisualStudio.Data Namespace