Share via


DataConnectionSupport.ConnectionTimeout Property

Gets or sets the amount of time to wait when establishing a connection before terminating the attempt and generating a timeout error.

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.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
An integer representation of the allowable timeout period.

Implements

IVsDataConnectionSupport.ConnectionTimeout

Remarks

The default value depends on the data provider. A value of zero indicates that there is no timeout, meaning the data provider will wait indefinitely, or until something other than the data provider causes it to timeout, such as 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.

Notes to Inheritors

The derived class should override this property.

.NET Framework Security

See Also

Reference

DataConnectionSupport Class

Microsoft.VisualStudio.Data.Framework Namespace