FtpWebRequest.BeginGetResponse メソッド

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

FtpWebRequest.BeginGetResponse メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

要求の非同期的な送信と、FTP サーバーからの応答の非同期的な受信を開始します。

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

Visual Basic (宣言)

Public Overrides Function
 BeginGetResponse ( _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (使用法)

Dim instance As FtpWebRequest
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginGetResponse(callback, state)

C#

public override IAsyncResult BeginGetResponse (
    AsyncCallback callback,
    Object state
)

C++

public:
virtual IAsyncResult^ BeginGetResponse (
    AsyncCallback^ callback, 
    Object^ state
) override

J#

public IAsyncResult BeginGetResponse (
    AsyncCallback callback, 
    Object state
)

JScript

public override function BeginGetResponse (
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

パラメータ

callback

操作の完了時に呼び出すメソッドを参照する AsyncCallback デリゲート。

state

操作に関する情報を格納するユーザー定義のオブジェクト。このオブジェクトは、操作の完了時に callback デリゲートに渡されます。

戻り値
操作の状態を示す IAsyncResult インスタンス。

例外

例外の種類	条件
InvalidOperationException	GetResponse または BeginGetResponse は、このインスタンスに対して既に呼び出されています。

解説

EndGetResponse メソッドを呼び出して、非同期操作を完了する必要があります。通常、EndGetResponse は、callback で参照されるメソッドによって呼び出されます。操作の状態を確認するには、BeginGetResponse メソッドで返される IAsyncResult オブジェクトのプロパティをチェックします。

Proxy プロパティが、直接または構成ファイルのいずれかで設定された場合、FTP サーバーとの通信は、指定したプロキシを経由して行われます。

BeginGetResponse は、サーバーからの応答の待機中もブロックしません。ブロックするには、BeginGetResponse の代わりに GetResponse メソッドを呼び出します。

非同期プログラミング モデルの使用法の詳細については、「同期メソッドの非同期呼び出し」を参照してください。

このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

メモ
WebException がスローされた場合は、例外の Response プロパティと Status プロパティを使用してサーバーからの応答を確認します。

呼び出し時の注意 このメソッドは、ネットワーク トラフィックを生成します。

使用例

要求のストリームを取得するための非同期操作を終了してから、応答を取得する要求を開始するコード例を次に示します。このコード例は FtpWebRequest クラスの概要で取り上げているコード例の一部分です。

C#

private static void EndGetStreamCallback(IAsyncResult
 ar)
{
    FtpState state = (FtpState) ar.AsyncState;
    
    Stream requestStream = null;
    // End the asynchronous call to get the request stream.
    try
    {
        requestStream = state.Request.EndGetRequestStream(ar);
        // 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(state.FileName);
        do
        {
            readBytes = stream.Read(buffer, 0, bufferLength);
            requestStream.Write(buffer, 0, readBytes);
            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();
        // Asynchronously get the response to the upload request.
        state.Request.BeginGetResponse(
            new AsyncCallback (EndGetResponseCallback), 
            state
        );
    } 
    // Return exceptions to the main application thread.
    catch (Exception e)
    {
        Console.WriteLine("Could not get the request stream.");
        state.OperationException = e;
        state.OperationComplete.Set();
        return;
    }
   
}

C++

private:
   static void EndGetStreamCallback( IAsyncResult^
 ar )
   {
      FtpState^ state = dynamic_cast<FtpState^>(ar->AsyncState);
      Stream^ requestStream = nullptr;

      // End the asynchronous call to get the request stream.
      try
      {
         requestStream = state->Request->EndGetRequestStream( ar );

         // Copy the file contents to the request stream.
         const int bufferLength = 2048;
         array<Byte>^buffer = gcnew array<Byte>(bufferLength);
         int count = 0;
         int readBytes = 0;
         FileStream^ stream = File::OpenRead( state->FileName );
         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();

         // Asynchronously get the response to the upload request.
         state->Request->BeginGetResponse( gcnew AsyncCallback( EndGetResponseCallback
 ), state );
      }
      // Return exceptions to the main application thread.
      catch ( Exception^ e ) 
      {
         Console::WriteLine( "Could not get the request stream."
 );
         state->OperationException = e;
         state->OperationComplete->Set();
         return;
      }
   }

プラットフォーム

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