Get(String,Int64,Stream) メソッド

指定したオフセットからダウンロードを開始し、宛先ストリームに書き込みます。

シンタックス

Visual Basic (宣言)
C#

Public Overloads Function Get( _
   ByVal remotePath As String, _
   ByVal remoteOffset As Long, _
   ByVal localDestination As Stream _
) As CopyResult

public CopyResult Get( 
   string remotePath,
   long remoteOffset,
   Stream localDestination
)

パラメータ

remotePath: サーバー上のファイルのパス。
remoteOffset: データ転送を開始する位置を示すリスタートマーカー。
localDestination: ファイルデータの書き込み先ストリーム。

戻り値の型

操作の結果を含むCopyResult。

解説

宛先ストリームは使用後に閉じません。このメソッドの実行中、DataIsBusyはtrueを返します。

使用例

以下のサンプルコードは、リスタートを使用してローカルファイルストリームの末尾に追記する方法を示します。 updateFile関数は、Ftp.Startメソッドに渡して非同期に実行できます。

private void updateFile()
{
    // 新しいリモートファイルデータをローカルファイルの末尾に追記します。
    ftp1.Session.RemoteEndPoint.HostNameOrAddress = myServer;
    ftp1.Session.Username = myUsername;
    ftp1.Session.Password = myPassword;
    ftp1.Connect();
    ftp1.Authenticate();

    // サーバーでリスタートがサポートされていることを確認します。
    if (ftp1.Features.Restart)
    {
        // System.IOを使用します。
        FileStream localLogFile = new FileStream(myLogFile, FileMode.Append, FileAccess.Write);

        // サーバーにはデータが周期的に追加されるログファイルがあります。 
        // このファイルに新しく追加されたデータを取得してローカルファイルの末尾に追記します。
        ftp1.Get("update.log", localLogFile.Length, localLogFile);
        localLogFile.Close();
    }
            
    ftp1.Close();
}

Visual Basic

Private Sub updateFile()
    ' 新しいリモートファイルデータをローカルファイルの末尾に追記します。
    ftp1.Session.RemoteEndPoint.HostNameOrAddress = myServer
    ftp1.Session.Username = myUsername
    ftp1.Session.Password = myPassword
    ftp1.Connect()
    ftp1.Authenticate()

    ' サーバーでリスタートがサポートされていることを確認します。
    If ftp1.Features.Restart Then
        ' System.IOを使用します。
        Dim localLogFile As FileStream = New FileStream(myLogFile, FileMode.Append, FileAccess.Write)

        ' サーバーにはデータが周期的に追加されるログファイルがあります。 
        ' このファイルに新しく追加されたデータを取得してローカルファイルの末尾に追記します。
        ftp1.Get("update.log", localLogFile.Length, localLogFile)
        localLogFile.Close()
    End If

    ftp1.Close()
End Sub

参照

パラメータ

戻り値の型

関連項目