Stream.CanRead Property (System.IO)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

Stream.CanRead Property

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

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

Syntax

Visual Basic (Declaration)

Public MustOverride ReadOnly Property CanRead As Boolean

Visual Basic (Usage)

Dim instance As Stream
Dim value As Boolean

value = instance.CanRead

public abstract bool CanRead { get; }

C++

public:
virtual property bool CanRead {
	bool get () abstract;
}

/** @property */
public abstract boolean get_CanRead ()

JScript

public abstract function get CanRead () : boolean

Property Value

true if the stream supports reading; otherwise, false.

Remarks

For an example of creating a file and writing text to a file, see How to: Write Text to a File. For an example of reading text from a file, see How to: Read Text from a File. For an example of reading from and writing to a binary file, see How to: Read and Write to a Newly Created Data File.

If a class derived from Stream does not support reading, calls to the Read, ReadByte, and BeginRead methods throw a NotSupportedException.

If the stream is closed, this property returns false.

Example

The following is an example of using the CanRead property.

Visual Basic

Imports System
Imports System.IO

Class TestRW

    Public Shared Sub Main()
        Dim fs As New FileStream("MyFile.txt", FileMode.OpenOrCreate, FileAccess.Read)
        If fs.CanRead And fs.CanWrite Then
            Console.WriteLine("MyFile.txt can be both written to and read from.")
        Else
            If fs.CanRead Then
                Console.WriteLine("MyFile.txt is not writable.")
            End If
        End If
    End Sub
End Class

using System;
using System.IO;
 
class TestRW 
{
    public static void Main(String[] args)
    {
        FileStream fs = new FileStream("MyFile.txt", FileMode.OpenOrCreate, FileAccess.Read);
        if (fs.CanRead && fs.CanWrite)
        {
            Console.WriteLine("MyFile.txt can be both written to and read from.");
        }
        else if (fs.CanRead)
        {
            Console.WriteLine("MyFile.txt is not writable.");
        }
    }
}

C++

using namespace System;
using namespace System::IO;
int main( void )
{
   FileStream^ fs = gcnew FileStream( "MyFile.txt",FileMode::OpenOrCreate,FileAccess::Read );
   if ( fs->CanRead && fs->CanWrite )
   {
      Console::WriteLine( "MyFile.txt can be both written to and read from." );
   }
   else
   {
      Console::WriteLine( "MyFile.txt is not writable" );
   }

   return 0;
}

import System.*;
import System.IO.*;

class TestRW
{
    public static void main(String[] args)
    {
        FileStream fs = new FileStream("MyFile.txt", 
            FileMode.OpenOrCreate, FileAccess.Read);
        if (fs.get_CanRead() && fs.get_CanWrite()) {
            Console.WriteLine("MyFile.txt can be both written to " 
                + "and read from.");
        }
        else {
            if (fs.get_CanRead()) {
                Console.WriteLine("MyFile.txt is not writable.");
            }
        }
    } //main
} //TestRW

JScript

 import System;
 import System.IO;
 
class TestRW 
{
   public static function Main() : void 
   {
 
         var fs : FileStream = new FileStream("MyFile.txt", FileMode.OpenOrCreate, FileAccess.Read);
         if (fs.CanRead && fs.CanWrite)
         {
            Console.WriteLine("MyFile.txt can be both written to and read from.");
         }
         else if (fs.CanRead)
         {
            Console.WriteLine("MyFile.txt is not writable.");
      }
   }
}
TestRW.Main();

Platforms

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

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

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Reference

Stream Class
Stream Members
System.IO Namespace

Other Resources

File and Stream I/O
How to: Read Text from a File
How to: Write Text to a File