Xceed .NET Libraries Documentation
DoOpenRead Method (SFtpFile)


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.
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

Return Value

A System.IO.Stream object that can be used to read data from the file.
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

Reference

SFtpFile Class
SFtpFile Members
Base Implementation in DoOpenRead