FileSystemWatcher.IncludeSubdirectories プロパティ

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

FileSystemWatcher.IncludeSubdirectories プロパティ

指定したパスのサブディレクトリを監視するかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property IncludeSubdirectories As
 Boolean

Visual Basic (使用法)

Dim instance As FileSystemWatcher
Dim value As Boolean

value = instance.IncludeSubdirectories

instance.IncludeSubdirectories = value

C#

public bool IncludeSubdirectories { get;
 set; }

C++

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

J#

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

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

JScript

public function get IncludeSubdirectories
 () : boolean

public function set IncludeSubdirectories
 (value : boolean)

プロパティ値
サブディレクトリを監視する場合は true。それ以外の場合は false。既定値は false です。

解説

Path プロパティで指定したディレクトリとそのサブディレクトリに含まれるファイルとディレクトリの変更通知をウォッチする場合は、IncludeSubdirectories を true に設定します。IncludeSubdirectories プロパティを false に設定すると、内部バッファに送られる通知の数が減少します。不要な通知をフィルタで排除する方法の詳細については、NotifyFilter プロパティと InternalBufferSize プロパティのトピックを参照してください。

true に設定した場合、IncludeSubdirectories は直接の子ディレクトリだけでなく、サブツリー全体を再帰的にウォッチします。ウォッチしている変更によって異なりますが、FileSystemEventArgs の Name プロパティおよび RenamedEventArgs の OldName プロパティに、サブツリー内のファイルまたはディレクトリの相対パスを返します。ウォッチしている変更によって異なりますが、FileSystemEventArgs の FullPath プロパティと、RenamedEventArgs の OldFullPath プロパティで絶対パスを取得できます。

ウォッチしているディレクトリのサブツリーにディレクトリが作成され、IncludeSubdirectories が true の場合、そのディレクトリは自動的にウォッチされます。

プラットフォーム

Windows 98, Windows 2000 SP4, 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、1.1、1.0

参照

関連項目
FileSystemWatcher クラス
FileSystemWatcher メンバ
System.IO 名前空間
NotifyFilter
FileSystemEventArgs クラス
FileSystemWatcher.Filter プロパティ
FileSystemEventArgs.FullPath プロパティ
RenamedEventArgs.OldFullPath
InternalBufferSize
FileSystemEventArgs.Name プロパティ
RenamedEventArgs.OldName
Path
RenamedEventArgs