Get(String,Int64) メソッド

最も低レベルのGetメソッド。指定したオフセットからダウンロードを開始し、読み取り元のストリームを返します。

シンタックス

Visual Basic (宣言)
C#

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

public Stream Get( 
   string remotePath,
   long remoteOffset
)

パラメータ

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

戻り値の型

読み取り元のStream。

解説

データ接続を利用するメソッドを呼び出すときは、事前にストリームを閉じる必要があります。コントロール接続を利用するメソッドを呼び出すときにも事前にストリームを閉じることを推奨します。

このメソッドの実行中、DataIsBusyはtrueを返します。

使用例

以下のサンプルコードは、ストリームを使用してサーバーからデータを受信しながら処理する方法を示します。 streamRecords関数は、Ftp.Startメソッドに渡して非同期に実行できます。

private void streamRecords()
{
    // 低レベルストリームを使用してファイルを取得します。
    ftp1.Session.RemoteEndPoint.HostNameOrAddress = myServer;
    ftp1.Session.Username = myUsername;
    ftp1.Session.Password = myPassword;
    ftp1.Connect();
    ftp1.Authenticate();

    // ストリーム受信されたデータを並行してテキストボックスに書き込みます。
    Stream stream = ftp1.Get("myRecords.txt", 0);
    byte[] buffer = new byte[1024];
    int count = -1;
    do
    {
        count = stream.Read(buffer, 0, buffer.Length);
        textBox1.AppendText(System.Text.Encoding.Default.GetString(buffer, 0, count));
    } while (count > 0) ;

    stream.Close();
    ftp1.Close();
}

Visual Basic

Private Sub streamRecords()
    ' 低レベルストリームを使用してファイルを取得します。
    ftp1.Session.RemoteEndPoint.HostNameOrAddress = myServer
    ftp1.Session.Username = myUsername
    ftp1.Session.Password = myPassword
    ftp1.Connect()
    ftp1.Authenticate()

    ' ストリーム受信されたデータを並行してテキストボックスに書き込みます。
    Dim stream As Stream = ftp1.Get("myRecords.txt", 0)
    Dim buffer() As Byte = New Byte(1023){}
    Dim count As Integer = -1
    Do
        count = stream.Read(buffer, 0, buffer.Length)
        textBox1.AppendText(System.Text.Encoding.Default.GetString(buffer, 0, count))
    Loop While count > 0

    stream.Close()
    ftp1.Close()
End Sub

参照

パラメータ

戻り値の型

関連項目