FtpWebRequest.ContentOffset プロパティ

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

FtpWebRequest.ContentOffset プロパティ

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

この要求でダウンロードされるファイル内のバイト オフセットを取得または設定します。

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

Visual Basic (宣言)

Public Property ContentOffset As
 Long

Visual Basic (使用法)

Dim instance As FtpWebRequest
Dim value As Long

value = instance.ContentOffset

instance.ContentOffset = value

C#

public long ContentOffset { get; set;
 }

C++

public:
property long long ContentOffset {
    long long get ();
    void set (long long value);
}

J#

/** @property */
public long get_ContentOffset ()

/** @property */
public void set_ContentOffset (long value)

JScript

public function get ContentOffset
 () : long

public function set ContentOffset
 (value : long)

プロパティ値
ファイルのオフセットをバイト単位で指定する Int64 インスタンス。既定値は 0 です。

例外

例外の種類	条件
InvalidOperationException	既に処理中の要求で、このプロパティに対して新しい値が指定されました。
ArgumentOutOfRangeException	このプロパティに対して指定された値が 0 未満です。

解説

FTP サーバーからファイルをダウンロードする場合は、ContentOffset プロパティを設定します。このオフセットは、ダウンロードされるデータの先頭をマークする、サーバーのファイル内の位置を示します。オフセットは、ファイルの先頭からのバイト数として指定されます。先頭のバイトのオフセットは 0 です。

ContentOffset を設定すると、FtpWebRequest は再起動 (REST) コマンドをサーバーに送信します。サーバーにデータをアップロードする場合、ほとんどの FTP サーバーはこのコマンドを無視します。

GetRequestStream、BeginGetRequestStream、GetResponse、または BeginGetResponse の各メソッドを呼び出した後に ContentOffset を変更すると、InvalidOperationException 例外が発生します。

使用例

サーバーからファイルの一部をダウンロードし、ダウンロードされたデータをローカル ファイルに追加するコード例を次に示します。

C#

public static bool RestartDownloadFromServer(string
 fileName, Uri serverUri, long offset)
{
    // The serverUri parameter should use the ftp:// scheme.
    // It identifies the server file that is to be downloaded
    // Example: ftp://contoso.com/someFile.txt.

    // The fileName parameter identifies the local file.
    //The serverUri parameter identifies the remote file.
    // The offset parameter specifies where in the server file to start
 reading data.
    
    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.DownloadFile;
    request.ContentOffset = offset;
    FtpWebResponse response = null;
    try 
    {
        response = (FtpWebResponse) request.GetResponse();
    }
    catch (WebException e)
    {
        Console.WriteLine (e.Status);
        Console.WriteLine (e.Message);
        return false;
    }
    // Get the data stream from the response.
    Stream newFile = response.GetResponseStream();
    // Use a StreamReader to simplify reading the response data.
    StreamReader reader  = new StreamReader(newFile);
    string newFileData = reader.ReadToEnd();
    // Append the response data to the local file
    // using a StreamWriter.
    StreamWriter writer = File.AppendText(fileName);
    writer.Write(newFileData);
    // Display the status description.

    // Cleanup.
    writer.Close();
    reader.Close();
    response.Close();
    Console.WriteLine("Download restart - status: {0}",response.StatusDescription);
    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

参照

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