FtpWebResponse.StatusDescription Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets text that describes a status code sent from the FTP server.

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

public string StatusDescription { get; }

Property Value

Type: System.String

A String instance that contains the status code and message returned with this response.

The text returned by the StatusDescription property includes the 3-digit StatusCode property value. When downloading data, the value of StatusDescription changes as status codes are returned by the FTP server. After you call the GetResponse method, StatusDescription contains an intermediate status code. When you call the Close method, StatusDescription contains the final status.

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.

public 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 = (FtpWebRequest)WebRequest.Create(serverUri);
    request.Method = WebRequestMethods.Ftp.DeleteFile;

    FtpWebResponse response = (FtpWebResponse) request.GetResponse();
    Console.WriteLine("Delete status: {0}",response.StatusDescription);  
    response.Close();
    return true;
}

.NET Framework
Available since 2.0
Return to top
Show: