FtpWebResponse.GetResponseStream Method

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.Requests.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: FtpWebResponse.cs

Source:: FtpWebResponse.cs

Source:: FtpWebResponse.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 override System::IO::Stream ^ GetResponseStream();

public override System.IO.Stream GetResponseStream ();

override this.GetResponseStream : unit -> System.IO.Stream

Public Overrides Function GetResponseStream () As Stream

Returns

Stream

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

Exceptions

InvalidOperationException

The response did not return a data stream.

Examples

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

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 = dynamic_cast<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 = dynamic_cast<FtpWebResponse^>(request->GetResponse());

   // The following streams are used to read the data returned from the server.
   Stream^ responseStream = nullptr;
   StreamReader^ readStream = nullptr;
   try
   {
      responseStream = response->GetResponseStream();
      readStream = gcnew StreamReader( responseStream,System::Text::Encoding::UTF8 );
      if ( readStream != nullptr )
      {
         // Display the data received from the server.
         Console::WriteLine( readStream->ReadToEnd() );
      }

      Console::WriteLine( "List status: {0}", response->StatusDescription );
   }
   finally
   {
      if ( readStream != nullptr )
      {
         readStream->Close();
      }

      if ( response != nullptr )
      {
         response->Close();
      }
   }

   return true;
}

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;
}

Remarks

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.

Applies to

Share via