FtpWebResponseとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

FtpWebResponse クラス

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

要求に対するファイル転送プロトコル (FTP: File Transfer Protocol) サーバーの応答をカプセル化します。

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

Visual Basic (宣言)

Public Class FtpWebResponse
    Inherits WebResponse
    Implements IDisposable

Visual Basic (使用法)

Dim instance As FtpWebResponse

public class FtpWebResponse : WebResponse,
 IDisposable

C++

public ref class FtpWebResponse : public
 WebResponse, IDisposable

public class FtpWebResponse extends WebResponse
 implements IDisposable

JScript

public class FtpWebResponse extends
 WebResponse implements IDisposable

解説

FtpWebResponse のインスタンスは、GetResponse メソッドを呼び出して取得します。返されたオブジェクトは、FtpWebResponse にキャストする必要があります。アプリケーションで FtpWebResponse オブジェクトが不要になると、Close メソッドを呼び出して、FtpWebResponse に保持されているリソースを解放します。

StatusCode プロパティにはサーバーが返したステータスコードが格納され、StatusDescription プロパティはステータスを示すステータスコードとメッセージを返します。これらのプロパティから返される値は、サーバーからメッセージが返されると変わります。

ListDirectory 要求に対して返されるファイル名のリストなど、要求で返されるすべてのデータは、GetResponseStream メソッドによって返されるストリームで使用できます。ストリームデータの長さは、ContentLength プロパティから取得できます。

使用例

FTP サーバー上のファイルを削除する要求を送信し、要求に対するサーバーの応答からステータスメッセージを表示するコード例を次に示します。これ以外の例については、WebRequestMethods.Ftp クラスと FtpWebRequest クラスのメンバのトピックを参照してください。

public static bool DeleteFileOnServer(Uri
 serverUri)
{
    // The serverUri parameter should use the ftp:// scheme.
    // It contains the name of the server file that is to be deleted.
    // Example: ftp://contoso.com/someFile.txt.
    // 
    
    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.DeleteFile;
 
    FtpWebResponse response = (FtpWebResponse) request.GetResponse();
    Console.WriteLine("Delete status: {0}",response.StatusDescription);
  
    response.Close();
    return true;
}

継承階層

System.Object
   System.MarshalByRefObject
     System.Net.WebResponse
      System.Net.FtpWebResponse

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
FtpWebResponse メンバ
System.Net 名前空間
FtpWebRequest クラス
FtpStatusCode 列挙体
WebRequestMethods.Ftp
WebRequest
WebResponse
WebClient

FtpWebResponse プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	BannerMessage	ログオン前に接続が確立された場合に、FTP サーバーが送信するメッセージを取得します。
	ContentLength	オーバーライドされます。 FTP サーバーから受信したデータの長さを取得します。
	ContentType	派生クラスでオーバーライドされると、受信しているデータのコンテンツタイプを取得または設定します。 ( WebResponse から継承されます。)
	ExitMessage	FTP セッションの終了時にサーバーが送信するメッセージを取得します。
	Headers	オーバーライドされます。空の WebHeaderCollection オブジェクトを取得します。
	IsFromCache	この応答がキャッシュから取得されたかどうかを示す Boolean 値を取得します。 ( WebResponse から継承されます。)
	IsMutuallyAuthenticated	相互認証が行われたかどうかを示す Boolean 値を取得します。 ( WebResponse から継承されます。)
	LastModified	FTP サーバー上のファイルが最後に変更された日時を取得します。
	ResponseUri	オーバーライドされます。要求に対する応答を送信する URI を取得します。
	StatusCode	FTP サーバーから送信された最新のステータスコードを取得します。
	StatusDescription	FTP サーバーから送信されたステータスコードを示すテキストを取得します。
	WelcomeMessage	認証の完了時に FTP サーバーが送信するメッセージを取得します。

参照

FtpWebResponse メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Close	オーバーライドされます。応答によって保持されているリソースを解放します。
	CreateObjRef	リモートオブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービスオブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetResponseStream	オーバーライドされます。 FTP サーバーから送信された応答データを格納しているストリームを取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービスオブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	GetObjectData	SerializationInfo に、オブジェクトをシリアル化するために必要なデータを設定します。 ( WebResponse から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)

参照

FtpWebResponse メンバ

要求に対するファイル転送プロトコル (FTP: File Transfer Protocol) サーバーの応答をカプセル化します。

FtpWebResponse データ型で公開されるメンバを以下の表に示します。

パブリックプロパティ

	名前	説明
	BannerMessage	ログオン前に接続が確立された場合に、FTP サーバーが送信するメッセージを取得します。
	ContentLength	オーバーライドされます。 FTP サーバーから受信したデータの長さを取得します。
	ContentType	派生クラスでオーバーライドされると、受信しているデータのコンテンツタイプを取得または設定します。(WebResponse から継承されます。)
	ExitMessage	FTP セッションの終了時にサーバーが送信するメッセージを取得します。
	Headers	オーバーライドされます。空の WebHeaderCollection オブジェクトを取得します。
	IsFromCache	この応答がキャッシュから取得されたかどうかを示す Boolean 値を取得します。(WebResponse から継承されます。)
	IsMutuallyAuthenticated	相互認証が行われたかどうかを示す Boolean 値を取得します。(WebResponse から継承されます。)
	LastModified	FTP サーバー上のファイルが最後に変更された日時を取得します。
	ResponseUri	オーバーライドされます。要求に対する応答を送信する URI を取得します。
	StatusCode	FTP サーバーから送信された最新のステータスコードを取得します。
	StatusDescription	FTP サーバーから送信されたステータスコードを示すテキストを取得します。
	WelcomeMessage	認証の完了時に FTP サーバーが送信するメッセージを取得します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Close	オーバーライドされます。応答によって保持されているリソースを解放します。
	CreateObjRef	リモートオブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービスオブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetResponseStream	オーバーライドされます。 FTP サーバーから送信された応答データを格納しているストリームを取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービスオブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetObjectData	SerializationInfo に、オブジェクトをシリアル化するために必要なデータを設定します。 (WebResponse から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)