Stream.CanTimeout Property (System.IO)

CanTimeout Property

.NET Framework Class Library

Stream..::.CanTimeout Property

Gets a value that determines whether the current stream can time out.

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

<ComVisibleAttribute(False)> _
Public Overridable ReadOnly Property CanTimeout As Boolean

Visual Basic (Usage)

Dim instance As Stream
Dim value As Boolean

value = instance.CanTimeout

[ComVisibleAttribute(false)]
public virtual bool CanTimeout { get; }

Visual C++

[ComVisibleAttribute(false)]
public:
virtual property bool CanTimeout {
    bool get ();
}

JScript

public function get CanTimeout () : boolean

Property Value

Type: System..::.Boolean
A value that determines whether the current stream can time out.

Remarks

The CanTimeout property always returns false. Some stream implementations require different behavior, such as NetworkStream, which times out if network connectivity is interrupted or lost. If you are implementing a stream that must be able to time out, this property should be overridden to return true.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference