FtpWebRequest.BeginGetRequestStream メソッド

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

FtpWebRequest.BeginGetRequestStream メソッド

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

書き込み用に、要求のコンテンツ ストリームの非同期的なオープンを開始します。

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

Visual Basic (宣言)

Public Overrides Function
 BeginGetRequestStream ( _
    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.BeginGetRequestStream(callback, state)

C#

public override IAsyncResult BeginGetRequestStream (
    AsyncCallback callback,
    Object state
)

C++

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

J#

public IAsyncResult BeginGetRequestStream (
    AsyncCallback callback, 
    Object state
)

JScript

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

パラメータ

callback

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

state

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

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

例外

例外の種類	条件
InvalidOperationException	このメソッドまたは GetRequestStream の前回の呼び出しがまだ完了していません。
WebException	FTP サーバーへの接続を確立できませんでした。
ProtocolViolationException	Method プロパティが、UploadFile に設定されていません。

解説

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

このメソッドは、ストリームの待機中もブロックしません。ブロックするには、このメソッドの代わりに GetRequestStream を呼び出します。

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

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

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

使用例

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

C#

// Command line arguments are two strings:
// 1. The url that is the name of the file being uploaded to the server.
// 2. The name of the file on the local machine.
//
public static void Main(string[]
 args)
{
    // Create a Uri instance with the specified URI string.
    // If the URI is not correctly formed, the Uri constructor
    // will throw an exception.
    ManualResetEvent waitObject;
    
    Uri target = new Uri (args[0]);
    string fileName = args[1];
    FtpState state = new FtpState();
    FtpWebRequest request = (FtpWebRequest)WebRequest.Create(target);
    request.Method = WebRequestMethods.Ftp.UploadFile;
    
    // This example uses anonymous logon.
    // The request is anonymous by default; the credential does not
 have to be specified. 
    // The example specifies the credential only to
    // control how actions are logged on the server.
    
    request.Credentials = new NetworkCredential ("anonymous"
,"janeDoe@contoso.com");
    
    // Store the request in the object that we pass into the
    // asynchronous operations.
    state.Request = request;
    state.FileName = fileName;
    
    // Get the event to wait on.
    waitObject = state.OperationComplete;
    
    // Asynchronously get the stream for the file contents.
    request.BeginGetRequestStream(
        new AsyncCallback (EndGetStreamCallback), 
        state
    );
    
    // Block the current thread until all operations are complete.
    waitObject.WaitOne();
    
    // The operations either completed or threw an exception.
    if (state.OperationException != null)
    {
        throw state.OperationException;
    }
    else
    {
        Console.WriteLine("The operation completed - {0}", state.StatusDescription);
    }
}

C++

// Command line arguments are two strings:
// 1. The url that is the name of the file being uploaded to the server.
// 2. The name of the file on the local machine.
//
static void Main()
{
   array<String^>^args = Environment::GetCommandLineArgs();

   // Create a Uri instance with the specified URI string.
   // If the URI is not correctly formed, the Uri constructor
   // will throw an exception.
   ManualResetEvent^ waitObject;
   Uri^ target = gcnew Uri( args[ 1 ] );
   String^ fileName = args[ 2 ];
   FtpState^ state = gcnew FtpState;
   FtpWebRequest ^ request = dynamic_cast<FtpWebRequest^>(WebRequest::Create(
 target ));
   request->Method = WebRequestMethods::Ftp::UploadFile;

   // This example uses anonymous logon.
   // The request is anonymous by default; the credential does not have
 to be specified. 
   // The example specifies the credential only to
   // control how actions are logged on the server.
   request->Credentials = gcnew NetworkCredential( "anonymous","janeDoe@contoso.com"
 );

   // Store the request in the object that we pass into the
   // asynchronous operations.
   state->Request = request;
   state->FileName = fileName;

   // Get the event to wait on.
   waitObject = state->OperationComplete;

   // Asynchronously get the stream for the file contents.
   request->BeginGetRequestStream( gcnew AsyncCallback( EndGetStreamCallback ),
 state );

   // Block the current thread until all operations are complete.
   waitObject->WaitOne();

   // The operations either completed or threw an exception.
   if ( state->OperationException != nullptr )
   {
      throw state->OperationException;
   }
   else
   {
      Console::WriteLine( "The operation completed - {0}", state->StatusDescription
 );
   }
}

プラットフォーム

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