Export (0) Print
Expand All

FtpWebResponse::GetResponseStream Method

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

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

public:
virtual Stream^ GetResponseStream() override

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.

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

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft