FtpWebRequest.UsePassive プロパティ

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

FtpWebRequest.UsePassive プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

クライアント アプリケーションのデータ転送処理の動作を取得または設定します。

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

Visual Basic (宣言)

Public Property UsePassive As
 Boolean

Visual Basic (使用法)

Dim instance As FtpWebRequest
Dim value As Boolean

value = instance.UsePassive

instance.UsePassive = value

C#

public bool UsePassive { get;
 set; }

C++

public:
property bool UsePassive {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_UsePassive ()

/** @property */
public void set_UsePassive (boolean value)

JScript

public function get UsePassive
 () : boolean

public function set UsePassive
 (value : boolean)

プロパティ値
クライアント アプリケーションのデータ転送処理がデータ ポートで接続を待機する場合は false。それ以外で、クライアントがデータ ポートで接続を開始する必要がある場合は true。既定値は true です。

例外

例外の種類	条件
InvalidOperationException	既に処理中の要求で、このプロパティに対して新しい値が指定されました。

解説

UsePassive プロパティを true に設定すると、サーバーに "PASV" コマンドが送信されます。このコマンドはサーバーに対して、データ ポートで待機し、転送コマンドの受信時に接続を開始するのではなく、接続を待つように要求します。

UsePassive の使用によって指定される動作の詳細については、RFC 959 『File Transfer Protocol』(http://www.rfc-editor.org/) の Section 3.2 「Establishing Data Connections」および Section 4.1.2 「Transfer Parameter Commands」を参照してください。

GetRequestStream、BeginGetRequestStream、GetResponse、または BeginGetResponse の各メソッドを呼び出した後に UsePassive を変更すると、InvalidOperationException 例外が発生します。

UsePassive が true に設定されている場合は、FTP サーバーがファイルのサイズを送信せず、ダウンロードの進行状況が常に 0 になることがあります。UsePassive が false に設定されている場合は、ファイアウォールで警告が発生し、ファイルのダウンロードがブロックされることがあります。

使用例

指定した FtpWebRequest オブジェクトのプロパティ値を、取得したり表示したりするコード例を次に示します。

C#

// DisplayRequestProperties prints a request's properties.
// This method should be called after the request is sent to the server.
       
private static void DisplayRequestProperties(FtpWebRequest
 request)
{
    Console.WriteLine("User {0} {1}", 
        request.Credentials.GetCredential(request.RequestUri,"basic").UserName
,
        request.RequestUri
    );
    Console.WriteLine("Request: {0} {1}", 
        request.Method,
        request.RequestUri
    );
    Console.WriteLine("Passive: {0}  Keep alive: {1}  Binary: {2} Timeout: {3}.",
 
        request.UsePassive, 
        request.KeepAlive, 
        request.UseBinary,
        request.Timeout == -1 ? "none" : request.Timeout.ToString()
    );
    IWebProxy proxy = request.Proxy;
    if (proxy != null)
    {
        Console.WriteLine("Proxy: {0}", proxy.GetProxy(request.RequestUri));
    } 
    else
    {
        Console.WriteLine("Proxy: (none)");
    }
    
    Console.WriteLine("ConnectionGroup: {0}",
        request.ConnectionGroupName == null ? "none"
 : request.ConnectionGroupName
    );

    Console.WriteLine("Encrypted connection: {0}", 
        request.EnableSsl);

    Console.WriteLine("Method: {0}", request.Method);
}

プラットフォーム

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