Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFile Class / OpenRead Method / OpenRead(FileSystemEvents,Object,Object,FileShare,FileOptions) Method


In This Topic
    OpenRead(FileSystemEvents,Object,Object,FileShare,FileOptions) Method
    In This Topic
    Opens the file for reading.
    Syntax
    'Declaration
     
    
    Public Overloads Function OpenRead( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object, _
       ByVal options As Object, _
       ByVal share As FileShare, _
       ByVal fileOptions As FileOptions _
    ) As Stream
    'Usage
     
    
    Dim instance As AbstractFile
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim options As Object
    Dim share As FileShare
    Dim fileOptions As FileOptions
    Dim value As Stream
     
    value = instance.OpenRead(events, userData, options, share, fileOptions)

    Parameters

    events
    userData
    options
    share
    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 file will be opened with System.IO.FileShare.Read shared access.

    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