Xceed Logo
Shop
Xceed .NET Libraries Documentation
[Root] / Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SFtpFile Class / DoOpenRead Method
A reference to a Xceed.FileSystem.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.
Options for controlling the file.


In This Topic
    DoOpenRead Method (SFtpFile)
    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 SFtpFile
Dim session As FileSystemEventsSession
Dim share As FileShare
Dim fileOptions As FileOptions
Dim value As Stream
 
value = instance.DoOpenRead(session, share, fileOptions)
    protected override Stream DoOpenRead( 
   FileSystemEventsSession session,
   FileShare share,
   FileOptions fileOptions
)

    Parameters

    session
    A reference to a Xceed.FileSystem.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
    Options for controlling the file.

    Return Value

    A System.IO.Stream object that can be used to read data from the file.
    Exceptions
    ExceptionDescription
    UnsupportedFileLockExceptionThrown when an Unsupported File Lock error condition occurs.
    ItemAccessDeniedException Thrown when an Item Access Denied error condition occurs.
    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.

    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

    Reference

    SFtpFile Class
    SFtpFile Members
    Base Implementation in DoOpenRead

    Send Feedback