Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFile Class / OpenRead Method / OpenRead(FileSystemEvents,Object) Method
A FileSystemEvents object that will be used to raise events. Cannot be null.
Opaque data that will be passed back to the event handler when an event is raised.


In This Topic
    OpenRead(FileSystemEvents,Object) Method
    In This Topic
    Opens the file for reading and raises events during the process.
    Syntax
    'Declaration
     
    
    Public Overloads Function OpenRead( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object _
    ) As Stream
    'Usage
     
    
    Dim instance As AbstractFile
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim value As Stream
     
    value = instance.OpenRead(events, userData)

    Parameters

    events
    A FileSystemEvents object that will be used to raise events. Cannot be null.
    userData
    Opaque data that will be passed back to the event handler when an event is raised.

    Return Value

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

    The file will be opened with System.IO.FileShare.Read shared access.

    The returned stream is guaranteed to be readable, but may or may not be seekable.

    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