1 <?xml version="1.0" encoding="utf-8"?><span>
4 <name>System.IO.FileSystem.Watcher</name>
7 <member name="T:System.IO.ErrorEventArgs">
8 <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Error"></see> event.</summary>
10 <member name="M:System.IO.ErrorEventArgs.#ctor(System.Exception)">
11 <summary>Initializes a new instance of the <see cref="T:System.IO.ErrorEventArgs"></see> class.</summary>
12 <param name="exception">An <see cref="T:System.Exception"></see> that represents the error that occurred.</param>
14 <member name="M:System.IO.ErrorEventArgs.GetException">
15 <summary>Gets the <see cref="T:System.Exception"></see> that represents the error that occurred.</summary>
16 <returns>An <see cref="T:System.Exception"></see> that represents the error that occurred.</returns>
18 <member name="T:System.IO.ErrorEventHandler">
19 <summary>Represents the method that will handle the <see cref="E:System.IO.FileSystemWatcher.Error"></see> event of a <see cref="T:System.IO.FileSystemWatcher"></see> object.</summary>
20 <param name="sender">The source of the event.</param>
21 <param name="e">An <see cref="T:System.IO.ErrorEventArgs"></see> object that contains the event data.</param>
23 <member name="T:System.IO.FileSystemEventArgs">
24 <summary>Provides data for the directory events: <see cref="E:System.IO.FileSystemWatcher.Changed"></see>, <see cref="E:System.IO.FileSystemWatcher.Created"></see>, <see cref="E:System.IO.FileSystemWatcher.Deleted"></see>.</summary>
26 <member name="M:System.IO.FileSystemEventArgs.#ctor(System.IO.WatcherChangeTypes,System.String,System.String)">
27 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemEventArgs"></see> class.</summary>
28 <param name="changeType">One of the <see cref="T:System.IO.WatcherChangeTypes"></see> values, which represents the kind of change detected in the file system.</param>
29 <param name="directory">The root directory of the affected file or directory.</param>
30 <param name="name">The name of the affected file or directory.</param>
32 <member name="P:System.IO.FileSystemEventArgs.ChangeType">
33 <summary>Gets the type of directory event that occurred.</summary>
34 <returns>One of the <see cref="T:System.IO.WatcherChangeTypes"></see> values that represents the kind of change detected in the file system.</returns>
36 <member name="P:System.IO.FileSystemEventArgs.FullPath">
37 <summary>Gets the fully qualifed path of the affected file or directory.</summary>
38 <returns>The path of the affected file or directory.</returns>
40 <member name="P:System.IO.FileSystemEventArgs.Name">
41 <summary>Gets the name of the affected file or directory.</summary>
42 <returns>The name of the affected file or directory.</returns>
44 <member name="T:System.IO.FileSystemEventHandler">
45 <summary>Represents the method that will handle the <see cref="E:System.IO.FileSystemWatcher.Changed"></see>, <see cref="E:System.IO.FileSystemWatcher.Created"></see>, or <see cref="E:System.IO.FileSystemWatcher.Deleted"></see> event of a <see cref="T:System.IO.FileSystemWatcher"></see> class.</summary>
46 <param name="sender">The source of the event.</param>
47 <param name="e">The <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
49 <member name="T:System.IO.FileSystemWatcher">
50 <summary>Listens to the file system change notifications and raises events when a directory, or file in a directory, changes.</summary>
52 <member name="M:System.IO.FileSystemWatcher.#ctor">
53 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher"></see> class.</summary>
55 <member name="M:System.IO.FileSystemWatcher.#ctor(System.String)">
56 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher"></see> class, given the specified directory to monitor.</summary>
57 <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
58 <exception cref="T:System.ArgumentNullException">The <paramref name="path">path</paramref> parameter is null.</exception>
59 <exception cref="T:System.ArgumentException">The <paramref name="path">path</paramref> parameter is an empty string (""). -or- The path specified through the <paramref name="path">path</paramref> parameter does not exist.</exception>
60 <exception cref="T:System.IO.PathTooLongException"><paramref name="path">path</paramref> is too long.</exception>
62 <member name="M:System.IO.FileSystemWatcher.#ctor(System.String,System.String)">
63 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher"></see> class, given the specified directory and type of files to monitor.</summary>
64 <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
65 <param name="filter">The type of files to watch. For example, "*.txt" watches for changes to all text files.</param>
66 <exception cref="T:System.ArgumentNullException">The <paramref name="path">path</paramref> parameter is null. -or- The <paramref name="filter">filter</paramref> parameter is null.</exception>
67 <exception cref="T:System.ArgumentException">The <paramref name="path">path</paramref> parameter is an empty string (""). -or- The path specified through the <paramref name="path">path</paramref> parameter does not exist.</exception>
68 <exception cref="T:System.IO.PathTooLongException"><paramref name="path">path</paramref> is too long.</exception>
70 <member name="M:System.IO.FileSystemWatcher.BeginInit">
71 <summary>Begins the initialization of a <see cref="T:System.IO.FileSystemWatcher"></see> used on a form or used by another component. The initialization occurs at run time.</summary>
73 <member name="E:System.IO.FileSystemWatcher.Changed">
74 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is changed.</summary>
77 <member name="E:System.IO.FileSystemWatcher.Created">
78 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is created.</summary>
81 <member name="E:System.IO.FileSystemWatcher.Deleted">
82 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is deleted.</summary>
85 <member name="M:System.IO.FileSystemWatcher.Dispose">
88 <member name="M:System.IO.FileSystemWatcher.Dispose(System.Boolean)">
89 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.FileSystemWatcher"></see> and optionally releases the managed resources.</summary>
90 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
92 <member name="P:System.IO.FileSystemWatcher.EnableRaisingEvents">
93 <summary>Gets or sets a value indicating whether the component is enabled.</summary>
94 <returns>true if the component is enabled; otherwise, false. The default is false. If you are using the component on a designer in Visual Studio 2005, the default is true.</returns>
95 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.FileSystemWatcher"></see> object has been disposed.</exception>
96 <exception cref="T:System.PlatformNotSupportedException">The current operating system is not Microsoft Windows NT or later.</exception>
97 <exception cref="T:System.IO.FileNotFoundException">The directory specified in <see cref="P:System.IO.FileSystemWatcher.Path"></see> could not be found.</exception>
98 <exception cref="T:System.ArgumentException"><see cref="P:System.IO.FileSystemWatcher.Path"></see> has not been set or is invalid.</exception>
100 <member name="M:System.IO.FileSystemWatcher.EndInit">
101 <summary>Ends the initialization of a <see cref="T:System.IO.FileSystemWatcher"></see> used on a form or used by another component. The initialization occurs at run time.</summary>
103 <member name="E:System.IO.FileSystemWatcher.Error">
104 <summary>Occurs when the instance of <see cref="T:System.IO.FileSystemWatcher"></see> is unable to continue monitoring changes or when the internal buffer overflows.</summary>
107 <member name="P:System.IO.FileSystemWatcher.Filter">
108 <summary>Gets or sets the filter string used to determine what files are monitored in a directory.</summary>
109 <returns>The filter string. The default is ".\" (Watches all files.)</returns>
111 <member name="P:System.IO.FileSystemWatcher.IncludeSubdirectories">
112 <summary>Gets or sets a value indicating whether subdirectories within the specified path should be monitored.</summary>
113 <returns>true if you want to monitor subdirectories; otherwise, false. The default is false.</returns>
115 <member name="P:System.IO.FileSystemWatcher.InternalBufferSize">
116 <summary>Gets or sets the size (in bytes) of the internal buffer.</summary>
117 <returns>The internal buffer size in bytes. The default is 8192 (8 KB).</returns>
119 <member name="P:System.IO.FileSystemWatcher.NotifyFilter">
120 <summary>Gets or sets the type of changes to watch for.</summary>
121 <returns>One of the <see cref="T:System.IO.NotifyFilters"></see> values. The default is the bitwise OR combination of LastWrite, FileName, and DirectoryName.</returns>
122 <exception cref="T:System.ArgumentException">The value is not a valid bitwise OR combination of the <see cref="T:System.IO.NotifyFilters"></see> values.</exception>
123 <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value that is being set is not valid.</exception>
125 <member name="M:System.IO.FileSystemWatcher.OnChanged(System.IO.FileSystemEventArgs)">
126 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Changed"></see> event.</summary>
127 <param name="e">A <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
129 <member name="M:System.IO.FileSystemWatcher.OnCreated(System.IO.FileSystemEventArgs)">
130 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Created"></see> event.</summary>
131 <param name="e">A <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
133 <member name="M:System.IO.FileSystemWatcher.OnDeleted(System.IO.FileSystemEventArgs)">
134 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Deleted"></see> event.</summary>
135 <param name="e">A <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
137 <member name="M:System.IO.FileSystemWatcher.OnError(System.IO.ErrorEventArgs)">
138 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Error"></see> event.</summary>
139 <param name="e">An <see cref="T:System.IO.ErrorEventArgs"></see> that contains the event data.</param>
141 <member name="M:System.IO.FileSystemWatcher.OnRenamed(System.IO.RenamedEventArgs)">
142 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Renamed"></see> event.</summary>
143 <param name="e">A <see cref="T:System.IO.RenamedEventArgs"></see> that contains the event data.</param>
145 <member name="P:System.IO.FileSystemWatcher.Path">
146 <summary>Gets or sets the path of the directory to watch.</summary>
147 <returns>The path to monitor. The default is an empty string ("").</returns>
148 <exception cref="T:System.ArgumentException">The specified path does not exist or could not be found. -or- The specified path contains wildcard characters. -or- The specified path contains invalid path characters.</exception>
150 <member name="E:System.IO.FileSystemWatcher.Renamed">
151 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is renamed.</summary>
154 <member name="P:System.IO.FileSystemWatcher.Site">
155 <summary>Gets or sets an <see cref="T:System.ComponentModel.ISite"></see> for the <see cref="T:System.IO.FileSystemWatcher"></see>.</summary>
156 <returns>An <see cref="T:System.ComponentModel.ISite"></see> for the <see cref="T:System.IO.FileSystemWatcher"></see>.</returns>
158 <member name="P:System.IO.FileSystemWatcher.SynchronizingObject">
159 <summary>Gets or sets the object used to marshal the event handler calls issued as a result of a directory change.</summary>
160 <returns>The <see cref="T:System.ComponentModel.ISynchronizeInvoke"></see> that represents the object used to marshal the event handler calls issued as a result of a directory change. The default is null.</returns>
162 <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)">
163 <summary>A synchronous method that returns a structure that contains specific information on the change that occurred, given the type of change you want to monitor.</summary>
164 <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes"></see> to watch for.</param>
165 <returns>A <see cref="T:System.IO.WaitForChangedResult"></see> that contains specific information on the change that occurred.</returns>
167 <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes,System.Int32)">
168 <summary>A synchronous method that returns a structure that contains specific information on the change that occurred, given the type of change you want to monitor and the time (in milliseconds) to wait before timing out.</summary>
169 <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes"></see> to watch for.</param>
170 <param name="timeout">The time (in milliseconds) to wait before timing out.</param>
171 <returns>A <see cref="T:System.IO.WaitForChangedResult"></see> that contains specific information on the change that occurred.</returns>
173 <member name="T:System.IO.InternalBufferOverflowException">
174 <summary>The exception thrown when the internal buffer overflows.</summary>
176 <member name="M:System.IO.InternalBufferOverflowException.#ctor">
177 <summary>Initializes a new default instance of the <see cref="T:System.IO.InternalBufferOverflowException"></see> class.</summary>
179 <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String)">
180 <summary>Initializes a new instance of the <see cref="T:System.IO.InternalBufferOverflowException"></see> class with the error message to be displayed specified.</summary>
181 <param name="message">The message to be given for the exception.</param>
183 <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
184 <summary>Initializes a new, empty instance of the <see cref="T:System.IO.InternalBufferOverflowException"></see> class that is serializable using the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> and <see cref="T:System.Runtime.Serialization.StreamingContext"></see> objects.</summary>
185 <param name="info">The information required to serialize the T:System.IO.InternalBufferOverflowException object.</param>
186 <param name="context">The source and destination of the serialized stream associated with the T:System.IO.InternalBufferOverflowException object.</param>
188 <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String,System.Exception)">
189 <summary>Initializes a new instance of the <see cref="T:System.IO.InternalBufferOverflowException"></see> class with the message to be displayed and the generated inner exception specified.</summary>
190 <param name="message">The message to be given for the exception.</param>
191 <param name="inner">The inner exception.</param>
193 <member name="T:System.IO.NotifyFilters">
194 <summary>Specifies changes to watch for in a file or folder.</summary>
196 <member name="F:System.IO.NotifyFilters.Attributes">
197 <summary>The attributes of the file or folder.</summary>
200 <member name="F:System.IO.NotifyFilters.CreationTime">
201 <summary>The time the file or folder was created.</summary>
204 <member name="F:System.IO.NotifyFilters.DirectoryName">
205 <summary>The name of the directory.</summary>
208 <member name="F:System.IO.NotifyFilters.FileName">
209 <summary>The name of the file.</summary>
212 <member name="F:System.IO.NotifyFilters.LastAccess">
213 <summary>The date the file or folder was last opened.</summary>
216 <member name="F:System.IO.NotifyFilters.LastWrite">
217 <summary>The date the file or folder last had anything written to it.</summary>
220 <member name="F:System.IO.NotifyFilters.Security">
221 <summary>The security settings of the file or folder.</summary>
224 <member name="F:System.IO.NotifyFilters.Size">
225 <summary>The size of the file or folder.</summary>
228 <member name="T:System.IO.RenamedEventArgs">
229 <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Renamed"></see> event.</summary>
231 <member name="M:System.IO.RenamedEventArgs.#ctor(System.IO.WatcherChangeTypes,System.String,System.String,System.String)">
232 <summary>Initializes a new instance of the <see cref="T:System.IO.RenamedEventArgs"></see> class.</summary>
233 <param name="changeType">One of the <see cref="T:System.IO.WatcherChangeTypes"></see> values.</param>
234 <param name="directory">The name of the affected file or directory.</param>
235 <param name="name">The name of the affected file or directory.</param>
236 <param name="oldName">The old name of the affected file or directory.</param>
238 <member name="P:System.IO.RenamedEventArgs.OldFullPath">
239 <summary>Gets the previous fully qualified path of the affected file or directory.</summary>
240 <returns>The previous fully qualified path of the affected file or directory.</returns>
242 <member name="P:System.IO.RenamedEventArgs.OldName">
243 <summary>Gets the old name of the affected file or directory.</summary>
244 <returns>The previous name of the affected file or directory.</returns>
246 <member name="T:System.IO.RenamedEventHandler">
247 <summary>Represents the method that will handle the <see cref="E:System.IO.FileSystemWatcher.Renamed"></see> event of a <see cref="T:System.IO.FileSystemWatcher"></see> class.</summary>
248 <param name="sender">The source of the event.</param>
249 <param name="e">The <see cref="T:System.IO.RenamedEventArgs"></see> that contains the event data.</param>
251 <member name="T:System.IO.WaitForChangedResult">
252 <summary>Contains information on the change that occurred.</summary>
254 <member name="P:System.IO.WaitForChangedResult.ChangeType">
255 <summary>Gets or sets the type of change that occurred.</summary>
256 <returns>One of the <see cref="T:System.IO.WatcherChangeTypes"></see> values.</returns>
258 <member name="P:System.IO.WaitForChangedResult.Name">
259 <summary>Gets or sets the name of the file or directory that changed.</summary>
260 <returns>The name of the file or directory that changed.</returns>
262 <member name="P:System.IO.WaitForChangedResult.OldName">
263 <summary>Gets or sets the original name of the file or directory that was renamed.</summary>
264 <returns>The original name of the file or directory that was renamed.</returns>
266 <member name="P:System.IO.WaitForChangedResult.TimedOut">
267 <summary>Gets or sets a value indicating whether the wait operation timed out.</summary>
268 <returns>true if the <see cref="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)"></see> method timed out; otherwise, false.</returns>
270 <member name="T:System.IO.WatcherChangeTypes">
271 <summary>Changes that might occur to a file or directory.</summary>
273 <member name="F:System.IO.WatcherChangeTypes.All">
274 <summary>The creation, deletion, change, or renaming of a file or folder.</summary>
277 <member name="F:System.IO.WatcherChangeTypes.Changed">
278 <summary>The change of a file or folder. The types of changes include: changes to size, attributes, security settings, last write, and last access time.</summary>
281 <member name="F:System.IO.WatcherChangeTypes.Created">
282 <summary>The creation of a file or folder.</summary>
285 <member name="F:System.IO.WatcherChangeTypes.Deleted">
286 <summary>The deletion of a file or folder.</summary>
289 <member name="F:System.IO.WatcherChangeTypes.Renamed">
290 <summary>The renaming of a file or folder.</summary>