Click to Rate and Give Feedback
TechNet
TechNet Library
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:
.NET Framework Class Library
FtpWebResponse..::.GetResponseStream Method

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

Namespace:  System.Net
Assembly:  System (in System.dll)
Visual Basic
Public Overrides Function GetResponseStream As Stream
C#
public override Stream GetResponseStream()
Visual C++
public:
virtual Stream^ GetResponseStream() override
F#
abstract GetResponseStream : unit -> Stream 
override GetResponseStream : unit -> Stream 

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.

Visual Basic
Public Shared Function ListFilesOnServer(ByVal serverUri As Uri) As Boolean
    ' The serverUri should start with the ftp:// scheme.
    If serverUri.Scheme <> Uri.UriSchemeFtp Then
        Return False
    End If
    ' Get the object used to communicate with the server.
    Dim request As FtpWebRequest = CType(WebRequest.Create(serverUri), FtpWebRequest)
    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.

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

    Dim response As FtpWebResponse = CType(request.GetResponse(), FtpWebResponse)

    ' The following streams are used to read the data returned from the server.
    Dim responseStream As Stream = Nothing
    Dim readStream As StreamReader = Nothing
    Try
        responseStream = response.GetResponseStream()
        readStream = New StreamReader(responseStream, Encoding.UTF8)

        If readStream IsNot Nothing Then
            ' Display the data received from the server.
            Console.WriteLine(readStream.ReadToEnd())
        End If
        Console.WriteLine("List status: {0}", response.StatusDescription)
    Finally
        If readStream IsNot Nothing Then
            readStream.Close()
        End If
        If response IsNot Nothing Then
            response.Close()
        End If
    End Try

    Return True
End Function
C#
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;
}
Visual C++
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, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2012 Microsoft. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker