Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / StreamFile 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 (StreamFile)
    In This Topic
    Opens the file for reading.
    Syntax
    'Declaration
     
    
    Protected Overrides Function DoOpenRead( _
       ByVal session As FileSystemEventsSession, _
       ByVal share As FileShare, _
       ByVal fileOptions As FileOptions _
    ) As Stream
    'Usage
     
    
    Dim instance As StreamFile
    Dim session As FileSystemEventsSession
    Dim share As FileShare
    Dim fileOptions As FileOptions
    Dim value As Stream
     
    value = instance.DoOpenRead(session, share, 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 is guaranteed to be readable, but may or may not be seekable.

    The share parameter allows you to control how the file is shared by different processes.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also