FtpWebResponse Class
Encapsulates a File Transfer Protocol (FTP) server's response to a request.
Assembly: System (in System.dll)
The FtpWebResponse type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | BannerMessage | Gets the message sent by the FTP server when a connection is established prior to logon. |
![]() | ContentLength | Gets the length of the data received from the FTP server. (Overrides WebResponse::ContentLength.) |
![]() | ContentType | When overridden in a derived class, gets or sets the content type of the data being received. (Inherited from WebResponse.) |
![]() | ExitMessage | Gets the message sent by the server when the FTP session is ending. |
![]() | Headers | Infrastructure. Gets an empty WebHeaderCollection object. (Overrides WebResponse::Headers.) |
![]() | IsFromCache | Gets a Boolean value that indicates whether this response was obtained from the cache. (Inherited from WebResponse.) |
![]() | IsMutuallyAuthenticated | Gets a Boolean value that indicates whether mutual authentication occurred. (Inherited from WebResponse.) |
![]() | LastModified | Gets the date and time that a file on an FTP server was last modified. |
![]() | ResponseUri | Gets the URI that sent the response to the request. (Overrides WebResponse::ResponseUri.) |
![]() | StatusCode | Gets the most recent status code sent from the FTP server. |
![]() | StatusDescription | Gets text that describes a status code sent from the FTP server. |
![]() | WelcomeMessage | Gets the message sent by the FTP server when authentication is complete. |
| Name | Description | |
|---|---|---|
![]() | Close | Frees the resources held by the response. (Overrides WebResponse::Close().) |
![]() | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetObjectData | Infrastructure. Populates a SerializationInfo with the data that is needed to serialize the target object. (Inherited from WebResponse.) |
![]() | GetResponseStream | Retrieves the stream that contains response data sent from an FTP server. (Overrides WebResponse::GetResponseStream().) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IDisposable::Dispose | Infrastructure. When overridden in a derived class, releases all resources used by the WebResponse. (Inherited from WebResponse.) |
![]() ![]() | ISerializable::GetObjectData | Infrastructure. Populates a SerializationInfo instance with the data that is needed to serialize WebResponse. (Inherited from WebResponse.) |
Instances of FtpWebResponse are obtained by calling the GetResponse method. The returned object must be cast to an FtpWebResponse. When your application no longer needs the FtpWebResponse object, call the Close method to free the resources held by the FtpWebResponse.
The StatusCode property contains the status code returned by the server, and the StatusDescription property returns the status code and a message that describes the status. The values returned by these properties change as the messages are returned by the server.
Any data returned by the request, such as the list of file names returned for a ListDirectory request, is available in the stream returned by the GetResponseStream method. The length of the stream data can be obtained from the ContentLength property.
The following code example sends a request to delete a file on an FTP server and displays the status message from the server's response to the request. For additional examples, see the members of the WebRequestMethods::Ftp and FtpWebRequest classes.
static bool DeleteFileOnServer( Uri^ serverUri ) { // The serverUri parameter should use the ftp:// scheme. // It contains the name of the server file that is to be deleted. // Example: ftp://contoso.com/someFile.txt. // 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::DeleteFile; FtpWebResponse^ response = dynamic_cast<FtpWebResponse^>(request->GetResponse()); Console::WriteLine( "Delete status: {0}", response->StatusDescription ); response->Close(); return true; }
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.
