FtpWebResponse.StatusDescription プロパティ

.NET Framework クラス ライブラリ リファレンス

FtpWebResponse.StatusDescription プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

FTP サーバーから送信されたステータス コードを示すテキストを取得します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 StatusDescription As String

Visual Basic (使用法)

Dim instance As FtpWebResponse
Dim value As String

value = instance.StatusDescription

C#

public string StatusDescription { get;
 }

C++

public:
property String^ StatusDescription {
    String^ get ();
}

J#

/** @property */
public String get_StatusDescription ()

JScript

public function get StatusDescription
 () : String

プロパティ値
この応答で返されたステータス コードとメッセージを格納している String インスタンス。

解説

StatusDescription プロパティが返すテキストには、3 桁の StatusCode プロパティ値が含まれます。データのダウンロード中は、FTP サーバーからステータス コードが返されるにつれて、StatusDescription の値が変わります。GetResponse メソッドを呼び出すと、StatusDescription には中間ステータス コードが格納されます。Close メソッドを呼び出すと、StatusDescription には最終的なステータスが格納されます。

使用例

FTP サーバー上のファイルを削除する要求を送信し、要求に対するサーバーの応答からステータス メッセージを表示するコード例を次に示します。

C#

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

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
FtpWebResponse クラス
FtpWebResponse メンバ
System.Net 名前空間
FtpWebRequest クラス
FtpStatusCode 列挙体
WebRequestMethods.Ftp
WebRequest
WebResponse
WebClient