Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpFile Class / OpenRead Method / OpenRead(RepresentationType) Method
A RepresentationType value indicating how the data is transferred from the FTP server.


In This Topic
    OpenRead(RepresentationType) Method
    In This Topic
    Opens the file for reading using the specified RepresentationType.
    Syntax
    'Declaration
     
    Public Overloads Function OpenRead( _
       ByVal representationType As RepresentationType _
    ) As Stream
    'Usage
     
    Dim instance As FtpFile
    Dim representationType As RepresentationType
    Dim value As Stream
     
    value = instance.OpenRead(representationType)
    public Stream OpenRead( 
       RepresentationType representationType
    )

    Parameters

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

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

    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