FtpWebResponse.StatusCode プロパティ

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

FtpWebResponse.StatusCode プロパティ

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

FTP サーバーから送信された最新のステータス コードを取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 StatusCode As FtpStatusCode

Visual Basic (使用法)

Dim instance As FtpWebResponse
Dim value As FtpStatusCode

value = instance.StatusCode

C#

public FtpStatusCode StatusCode { get; }

C++

public:
property FtpStatusCode StatusCode {
    FtpStatusCode get ();
}

J#

/** @property */
public FtpStatusCode get_StatusCode ()

JScript

public function get StatusCode
 () : FtpStatusCode

プロパティ値
この応答で返された最新のステータス コードを示す FtpStatusCode 値。

解説

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

使用例

サーバーにファイルをアップロードして、ステータスを表示するコード例を次に示します。

C#

public static bool UploadFileToServer(string
 fileName, Uri serverUri)
{
    // The URI described by serverUri should use the ftp:// scheme.
    // It contains the name of the file on the server.
    // Example: ftp://contoso.com/someFile.txt.
    // 
    // The fileName parameter identifies the file containing the data
 to be uploaded.

    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.UploadFile;
    // Don't set a time limit for the operation to complete.
    request.Timeout = System.Threading.Timeout.Infinite;            
    
    // Copy the file contents to the request stream.
    const int bufferLength = 2048;
    byte[] buffer = new byte[bufferLength];
   
    int count = 0;
    int readBytes = 0;
    FileStream stream = File.OpenRead(fileName);
    Stream requestStream = request.GetRequestStream();
    do
    {
        readBytes = stream.Read(buffer, 0, bufferLength);
        requestStream.Write(buffer, 0, bufferLength);
        count += readBytes;
    }
    while (readBytes != 0);
    
    Console.WriteLine ("Writing {0} bytes to the stream.", count);
    // IMPORTANT: Close the request stream before sending the request.
    requestStream.Close();

    FtpWebResponse response = (FtpWebResponse) request.GetResponse();
    Console.WriteLine("Upload status: {0}, {1}", response.StatusCode, 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