FileSystemEventArgs

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

FileSystemEventArgs クラス

ディレクトリ イベントの Changed、Created、Deleted にデータを提供します。

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

Visual Basic (宣言)

Public Class FileSystemEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As FileSystemEventArgs

C#

public class FileSystemEventArgs : EventArgs

C++

public ref class FileSystemEventArgs : public
 EventArgs

J#

public class FileSystemEventArgs extends EventArgs

JScript

public class FileSystemEventArgs extends
 EventArgs

解説

FileSystemEventArgs クラスは、これらのイベントのイベント ハンドラにパラメータとして渡されます。

Changed イベントは、FileSystemWatcher の指定した Path で、ファイルまたはディレクトリのサイズ、システム属性、最後の書き込み時刻、最後のアクセス時刻、またはセキュリティ アクセス許可に変更が加えられた場合に発生します。

Created イベントは、FileSystemWatcher の指定した Path で、ファイルまたはディレクトリが作成された場合に発生します。

Deleted イベントは、FileSystemWatcher の指定した Path で、ファイルまたはディレクトリが削除された場合に発生します。詳細については、「FileSystemWatcher」を参照してください。

使用例

FileSystemWatcher を作成し、ディスク ドライブ上でのファイルの変更 (作成、削除、名前変更、変更) を監視する例を次に示します。この例では、エラーの通知を正しく受け取る方法も示されています。

Visual Basic

Imports System.IO

Module Module1
    Sub Main()
        ' Create a FileSystemWatcher to monitor all files on drive C.
        Dim fsw As New FileSystemWatcher("C:\")

        ' Watch for changes in LastAccess and LastWrite times, and
        ' the renaming of files or directories. 
        fsw.NotifyFilter = (NotifyFilters.LastAccess Or NotifyFilters.LastWrite
 _ 
            Or NotifyFilters.FileName Or NotifyFilters.DirectoryName)

        ' Register a handler that gets called when a 
        ' file is created, changed, or deleted.
        AddHandler fsw.Changed, New FileSystemEventHandler(AddressOf
 OnChanged)

        ' The commented line of code below is a shorthand of the above
 line.
        ' AddHandler fsw.Changed, AddressOf OnChanged

        ' NOTE: The shorthand version is used in the remainder of this
 code.
        ' FileSystemEventHandler
        AddHandler fsw.Created, AddressOf OnChanged
 
        ' FileSystemEventHandler
        AddHandler fsw.Deleted, AddressOf OnChanged

        ' Register a handler that gets called when a file is renamed.
        ' RenamedEventHandler
        AddHandler fsw.Renamed, AddressOf OnRenamed

        ' Register a handler that gets called if the 
        ' FileSystemWatcher needs to report an error.
        ' ErrorEventHandler
        AddHandler fsw.Error, AddressOf OnError

        ' Begin watching.
        fsw.EnableRaisingEvents = True

        ' Wait for the user to quit the program.
        Console.WriteLine("Press 'Enter' to quit the sample.")
        Console.ReadLine()
    End Sub

    ' This method is called when a file is created, changed, or deleted.
    Private Sub OnChanged(ByVal
 source As Object, ByVal
 e As FileSystemEventArgs)

        ' Show that a file has been created, changed, or deleted.
        Dim wct As WatcherChangeTypes = e.ChangeType
        Console.WriteLine("File {0} {1}", e.FullPath,
 wct.ToString())
    End Sub

    ' This method is called when a file is renamed.
    Private Sub OnRenamed(ByVal
 source As Object, ByVal
 e As RenamedEventArgs)

        ' Show that a file has been renamed.
        Dim wct As WatcherChangeTypes = e.ChangeType
        Console.WriteLine("File {0} {2} to {1}", e.OldFullPath,
 e.FullPath, wct.ToString())
    End Sub

    ' This method is called when the FileSystemWatcher detects an error.
    Private Sub OnError(ByVal
 source As Object, ByVal
 e As ErrorEventArgs)

        ' Show that an error has been detected.
        Console.WriteLine("The FileSystemWatcher has detected
 an error")

        ' Give more information if the error is due to an internal buffer
 overflow.
        If TypeOf e.GetException Is
 InternalBufferOverflowException Then
            ' This can happen if Windows is reporting many file system
 events quickly 
            ' and internal buffer of the  FileSystemWatcher is not large
 enough to handle this
            ' rate of events. The InternalBufferOverflowException error
 informs the application
            ' that some of the file system events are being lost.
            Console.WriteLine( _
                "The file system watcher experienced an internal
 buffer overflow: " _
                + e.GetException.Message)
        End If
    End Sub
End Module

継承階層

System.Object
   System.EventArgs
    System.IO.FileSystemEventArgs
       System.IO.RenamedEventArgs

スレッド セーフ

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

プラットフォーム

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

参照

関連項目
FileSystemEventArgs メンバ
System.IO 名前空間
Changed
Created
Deleted
FileSystemEventHandler
FileSystemWatcher
InternalBufferOverflowException
NotifyFilters
OnCreated
OnDeleted
Path
RenamedEventArgs
RenamedEventHandler
WaitForChangedResult
WatcherChangeTypes

FileSystemEventArgs コンストラクタ

FileSystemEventArgs クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    changeType As WatcherChangeTypes, _
    directory As String, _
    name As String _
)

Visual Basic (使用法)

Dim changeType As WatcherChangeTypes
Dim directory As String
Dim name As String

Dim instance As New FileSystemEventArgs(changeType,
 directory, name)

C#

public FileSystemEventArgs (
    WatcherChangeTypes changeType,
    string directory,
    string name
)

C++

public:
FileSystemEventArgs (
    WatcherChangeTypes changeType, 
    String^ directory, 
    String^ name
)

J#

public FileSystemEventArgs (
    WatcherChangeTypes changeType, 
    String directory, 
    String name
)

JScript

public function FileSystemEventArgs (
    changeType : WatcherChangeTypes, 
    directory : String, 
    name : String
)

パラメータ

changeType

ファイル システムで検出する変更の種類を表す WatcherChangeTypes 値の 1 つ。

directory

影響を受けるファイルまたはディレクトリのルート ディレクトリ。

name

影響を受けるファイルまたはディレクトリの名前。

プラットフォーム

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

参照

関連項目
FileSystemEventArgs クラス
FileSystemEventArgs メンバ
System.IO 名前空間
FileSystemWatcher
WatcherChangeTypes

FileSystemEventArgs プロパティ

パブリック プロパティ

	名前	説明
	ChangeType	発生したディレクトリ イベントの種類を取得します。
	FullPath	影響を受けるファイルまたはディレクトリの絶対パスを取得します。
	Name	影響を受けるファイルまたはディレクトリの名前を取得します。

参照

関連項目

FileSystemEventArgs クラス
System.IO 名前空間
Changed
Created
Deleted
FileSystemEventHandler
FileSystemWatcher
InternalBufferOverflowException
NotifyFilters
OnCreated
OnDeleted
Path
RenamedEventArgs
RenamedEventHandler
WaitForChangedResult
WatcherChangeTypes

FileSystemEventArgs メソッド

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

FileSystemEventArgs クラス
System.IO 名前空間
Changed
Created
Deleted
FileSystemEventHandler
FileSystemWatcher
InternalBufferOverflowException
NotifyFilters
OnCreated
OnDeleted
Path
RenamedEventArgs
RenamedEventHandler
WaitForChangedResult
WatcherChangeTypes

FileSystemEventArgs メンバ

ディレクトリ イベントの Changed、Created、Deleted にデータを提供します。

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

パブリック コンストラクタ

	名前	説明
	FileSystemEventArgs	FileSystemEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	ChangeType	発生したディレクトリ イベントの種類を取得します。
	FullPath	影響を受けるファイルまたはディレクトリの絶対パスを取得します。
	Name	影響を受けるファイルまたはディレクトリの名前を取得します。

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

FileSystemEventArgs クラス
System.IO 名前空間
Changed
Created
Deleted
FileSystemEventHandler
FileSystemWatcher
InternalBufferOverflowException
NotifyFilters
OnCreated
OnDeleted
Path
RenamedEventArgs
RenamedEventHandler
WaitForChangedResult
WatcherChangeTypes