Export (0) Print
Expand All

FtpWebResponse.StatusDescription Property

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;
}
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 = dynamic_cast<FtpWebRequest*>(WebRequest::Create(serverUri));
        request->Method = FtpMethods::DeleteFile;

        FtpWebResponse* response = dynamic_cast<FtpWebResponse*> (request->GetResponse());
        Console::WriteLine(S"Delete status: {0}",response->StatusDescription);  
        response->Close();
        return true;
    }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft