Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFile Class / DoOpenRead Method
A reference to a FileSystemEventsSession object which is responsible for raising all events that occur during the process.
A System.IO.FileShare constant that determines how the file will be shared by different processes.


In This Topic
    DoOpenRead Method (AbstractFile)
    In This Topic
    Opens the file for reading.
    Syntax
    'Declaration
     
    Protected MustOverride Function DoOpenRead( _
       ByVal session As FileSystemEventsSession, _
       ByVal share As FileShare, _
       ByVal fileOptions As FileOptions _
    ) As Stream
    'Usage
     
    Dim instance As AbstractFile
    Dim session As FileSystemEventsSession
    Dim share As FileShare
    Dim fileOptions As FileOptions
    Dim value As Stream
     
    value = instance.DoOpenRead(session, share, fileOptions)
    protected abstract Stream DoOpenRead( 
       FileSystemEventsSession session,
       FileShare share,
       FileOptions fileOptions
    )

    Parameters

    session
    A reference to a FileSystemEventsSession object which is responsible for raising all events that occur during the process.
    share
    A System.IO.FileShare constant that determines how the file will be shared by different processes.
    fileOptions

    Return Value

    A System.IO.Stream object that can be used to read data from the file.
    Remarks

    The returned stream should be guaranteed to be readable, but does not have to be seekable.

    The share parameter should allow control over how the file is shared by different processes. If the values defined in this enumeration are not supported, an exception should thrown.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also