GetResponseStream Method
Collapse the table of content
Expand the table of content

FtpWebResponse.GetResponseStream Method ()

 

Retrieves the stream that contains response data sent from an FTP server.

Namespace:   System.Net
Assembly:  System (in System.dll)

public override Stream GetResponseStream()

Return Value

Type: System.IO.Stream

A readable Stream instance that contains data returned with the response; otherwise, Null if no response data was returned by the server.

Exception Condition
InvalidOperationException

The response did not return a data stream.

After reading the data, you must close the stream. The stream is automatically closed when you close the FtpWebResponse object that contains it.

An exception is thrown unless the request method is DownloadFile or ListDirectory.

The following code example demonstrates getting the response stream for a ListDirectory request.

public static bool ListFilesOnServer(Uri serverUri)
{
    // The serverUri should start with the ftp:// scheme.
    if (serverUri.Scheme != Uri.UriSchemeFtp)
    {
        return false;
    }
    // Get the object used to communicate with the server.
    FtpWebRequest request = (FtpWebRequest)WebRequest.Create(serverUri);
    request.Method = WebRequestMethods.Ftp.ListDirectory;

    // Get the ServicePoint object used for this request, and limit it to one connection.
    // In a real-world application you might use the default number of connections (2),
    // or select a value that works best for your application.

    ServicePoint sp = request.ServicePoint;
    Console.WriteLine("ServicePoint connections = {0}.", sp.ConnectionLimit);
    sp.ConnectionLimit = 1;

    FtpWebResponse response = (FtpWebResponse) request.GetResponse();

    // The following streams are used to read the data returned from the server.
    Stream responseStream = null;
    StreamReader readStream = null;
    try
    {
        responseStream = response.GetResponseStream(); 
        readStream = new StreamReader(responseStream, System.Text.Encoding.UTF8);

        if (readStream != null)
        {
            // Display the data received from the server.
            Console.WriteLine(readStream.ReadToEnd());
        } 
        Console.WriteLine("List status: {0}",response.StatusDescription);            
    }
    finally
    {
        if (readStream != null)
        {
            readStream.Close();
        }
        if (response != null)
        {
            response.Close();
        }
    }

    return true;
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft