'Declaration
 
Public Overloads Function OpenRead( _
   ByVal events As FileSystemEvents, _
   ByVal userData As Object, _
   ByVal share As FileShare, _
   ByVal representationType As RepresentationType _
) As Stream

'Usage
 
Dim instance As FtpFile
Dim events As FileSystemEvents
Dim userData As Object
Dim share As FileShare
Dim representationType As RepresentationType
Dim value As Stream
 
value = instance.OpenRead(events, userData, share, representationType)

public Stream OpenRead( 
   FileSystemEvents events,
   object userData,
   FileShare share,
   RepresentationType representationType
)

Parameters

events

A Xceed.FileSystem.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.

share

A System.IO.FileShare constant that determines how the file will be shared by different processes.

representationType

A RepresentationType value indicating how the data is transferred from the FTP server.

Return Value

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

Since the stream returned by the OpenRead method is not seekable (meaning that neither the length or position can be retrieved), data can be read by either looping through the stream until the end of the stream has been reached, or a StreamReader can be created around the stream to read the data.

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

Reference

FtpFile Class
FtpFile Members
Overload List
RepresentationType Enumeration
System.IO.Stream
System.IO.FileShare
RepresentationType Enumeration