FtpWebRequest.GetResponse メソッド

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

FtpWebRequest.GetResponse メソッド

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

FTP サーバーの応答を返します。

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

Visual Basic (宣言)

Public Overrides Function
 GetResponse As WebResponse

Visual Basic (使用法)

Dim instance As FtpWebRequest
Dim returnValue As WebResponse

returnValue = instance.GetResponse

C#

public override WebResponse GetResponse ()

C++

public:
virtual WebResponse^ GetResponse () override

J#

public WebResponse GetResponse ()

JScript

public override function GetResponse () : WebResponse

戻り値
FtpWebResponse インスタンスを格納している WebResponse 参照。このオブジェクトは、要求に対する FTP サーバーの応答を格納しています。

例外

例外の種類	条件
InvalidOperationException	GetResponse または BeginGetResponse は、このインスタンスに対して既に呼び出されています。 または HTTP プロキシが有効で、WebRequestMethods.Ftp.DownloadFile、WebRequestMethods.Ftp.ListDirectory、または WebRequestMethods.Ftp.ListDirectoryDetails 以外の FTP コマンドを使用しようとしました。
WebException	EnableSsl は true に設定されていますが、サーバーはこの機能をサポートしていません。

解説

FTP に固有のプロパティにアクセスするには、このメソッドによって返される WebResponse オブジェクトを FtpWebResponse にキャストする必要があります。

GetResponse によって制御接続が確立されます。また、データ接続も作成される場合があります。GetResponse は、応答を受信するまでブロックします。これを避けるには、GetResponse の代わりに BeginGetResponse メソッドと EndGetResponse メソッドを呼び出して、この操作を非同期的に実行できます。

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

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

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

メモ
GetResponse を何回呼び出しても、同じ応答オブジェクトが返されます。要求は再発行されません。

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

使用例

要求のデータ ストリームにファイルをコピーし、サーバーに要求を送信して、サーバーへのファイルにデータを追加するコード例を次に示します。この例では、GetResponse を呼び出して要求を送信し、サーバーによって応答が返されるまでブロックします。

C#

public static bool AppendFileOnServer(string
 fileName, Uri serverUri)
{
    // The URI described by serverUri should use the ftp:// scheme.
    // It contains the name of the file on the server.
    // Example: ftp://contoso.com/someFile.txt. 
    // The fileName parameter identifies the file containing 
    // the data to be appended to the file on the server.
    
    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.AppendFile;
    
    StreamReader sourceStream = new StreamReader(fileName);
    byte [] fileContents = Encoding.UTF8.GetBytes(sourceStream.ReadToEnd());
    sourceStream.Close();
    request.ContentLength = fileContents.Length;
 
    // This example assumes the FTP site uses anonymous logon.
    request.Credentials = new NetworkCredential ("anonymous"
,"janeDoe@contoso.com");
    Stream requestStream = request.GetRequestStream();
    requestStream.Write(fileContents, 0, fileContents.Length);
    requestStream.Close();
    FtpWebResponse response = (FtpWebResponse) request.GetResponse();
    
    Console.WriteLine("Append status: {0}",response.StatusDescription);
    
    response.Close();  
    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