1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.IO.FileSystem.Watcher</name>
6 <member name="T:System.IO.NotifyFilters">
7 <summary>Specifies changes to watch for in a file or folder.</summary>
9 <member name="F:System.IO.NotifyFilters.Attributes">
10 <summary>The attributes of the file or folder.</summary>
13 <member name="F:System.IO.NotifyFilters.CreationTime">
14 <summary>The time the file or folder was created.</summary>
17 <member name="F:System.IO.NotifyFilters.DirectoryName">
18 <summary>The name of the directory.</summary>
21 <member name="F:System.IO.NotifyFilters.FileName">
22 <summary>The name of the file.</summary>
25 <member name="F:System.IO.NotifyFilters.LastAccess">
26 <summary>The date the file or folder was last opened.</summary>
29 <member name="F:System.IO.NotifyFilters.LastWrite">
30 <summary>The date the file or folder last had anything written to it.</summary>
33 <member name="F:System.IO.NotifyFilters.Security">
34 <summary>The security settings of the file or folder.</summary>
37 <member name="F:System.IO.NotifyFilters.Size">
38 <summary>The size of the file or folder.</summary>
41 <member name="T:System.IO.ErrorEventArgs">
42 <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Error"></see> event.</summary>
44 <member name="M:System.IO.ErrorEventArgs.#ctor(System.Exception)">
45 <summary>Initializes a new instance of the <see cref="T:System.IO.ErrorEventArgs"></see> class.</summary>
46 <param name="exception">An <see cref="T:System.Exception"></see> that represents the error that occurred.</param>
48 <member name="M:System.IO.ErrorEventArgs.GetException">
49 <summary>Gets the <see cref="T:System.Exception"></see> that represents the error that occurred.</summary>
50 <returns>An <see cref="System.Exception"></see> that represents the error that occurred.</returns>
52 <member name="T:System.IO.ErrorEventHandler">
53 <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>
54 <param name="sender">The source of the event.</param>
55 <param name="e">An <see cref="T:System.IO.ErrorEventArgs"></see> object that contains the event data.</param>
57 <member name="T:System.IO.FileSystemEventArgs">
58 <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>
60 <member name="M:System.IO.FileSystemEventArgs.#ctor(System.IO.WatcherChangeTypes,System.String,System.String)">
61 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemEventArgs"></see> class.</summary>
62 <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>
63 <param name="directory">The root directory of the affected file or directory.</param>
64 <param name="name">The name of the affected file or directory.</param>
66 <member name="P:System.IO.FileSystemEventArgs.ChangeType">
67 <summary>Gets the type of directory event that occurred.</summary>
68 <returns>One of the <see cref="System.IO.WatcherChangeTypes"></see> values that represents the kind of change detected in the file system.</returns>
70 <member name="P:System.IO.FileSystemEventArgs.FullPath">
71 <summary>Gets the fully qualifed path of the affected file or directory.</summary>
72 <returns>The path of the affected file or directory.</returns>
74 <member name="P:System.IO.FileSystemEventArgs.Name">
75 <summary>Gets the name of the affected file or directory.</summary>
76 <returns>The name of the affected file or directory.</returns>
78 <member name="T:System.IO.FileSystemEventHandler">
79 <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>
80 <param name="sender">The source of the event.</param>
81 <param name="e">The <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
83 <member name="T:System.IO.FileSystemWatcher">
84 <summary>Listens to the file system change notifications and raises events when a directory, or file in a directory, changes.</summary>
86 <member name="M:System.IO.FileSystemWatcher.#ctor">
87 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher"></see> class.</summary>
89 <member name="M:System.IO.FileSystemWatcher.#ctor(System.String)">
90 <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher"></see> class, given the specified directory to monitor.</summary>
91 <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
92 <exception cref="T:System.ArgumentNullException">The <paramref name="path">path</paramref> parameter is null.</exception>
93 <exception cref="T:System.ArgumentException">The <paramref name="path">path</paramref> parameter is an empty string (&quot;&quot;).
95 The path specified through the <paramref name="path">path</paramref> parameter does not exist.</exception>
96 <exception cref="T:System.IO.PathTooLongException"><paramref name="path">path</paramref> is too long.</exception>
98 <member name="M:System.IO.FileSystemWatcher.#ctor(System.String,System.String)">
99 <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>
100 <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
101 <param name="filter">The type of files to watch. For example, &quot;*.txt&quot; watches for changes to all text files.</param>
102 <exception cref="T:System.ArgumentNullException">The <paramref name="path">path</paramref> parameter is null.
104 The <paramref name="filter">filter</paramref> parameter is null.</exception>
105 <exception cref="T:System.ArgumentException">The <paramref name="path">path</paramref> parameter is an empty string (&quot;&quot;).
107 The path specified through the <paramref name="path">path</paramref> parameter does not exist.</exception>
108 <exception cref="T:System.IO.PathTooLongException"><paramref name="path">path</paramref> is too long.</exception>
110 <member name="M:System.IO.FileSystemWatcher.BeginInit">
111 <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>
113 <member name="E:System.IO.FileSystemWatcher.Changed">
114 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is changed.</summary>
116 <member name="E:System.IO.FileSystemWatcher.Created">
117 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is created.</summary>
119 <member name="E:System.IO.FileSystemWatcher.Deleted">
120 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is deleted.</summary>
122 <member name="M:System.IO.FileSystemWatcher.Dispose">
125 <member name="M:System.IO.FileSystemWatcher.Dispose(System.Boolean)">
126 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.FileSystemWatcher"></see> and optionally releases the managed resources.</summary>
127 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
129 <member name="P:System.IO.FileSystemWatcher.EnableRaisingEvents">
130 <summary>Gets or sets a value indicating whether the component is enabled.</summary>
131 <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>
132 <exception cref="T:System.ObjectDisposedException">The <see cref="System.IO.FileSystemWatcher"></see> object has been disposed.</exception>
133 <exception cref="T:System.PlatformNotSupportedException">The current operating system is not Microsoft Windows NT or later.</exception>
134 <exception cref="T:System.IO.FileNotFoundException">The directory specified in <see cref="System.IO.FileSystemWatcher.Path"></see> could not be found.</exception>
135 <exception cref="T:System.ArgumentException"><see cref="System.IO.FileSystemWatcher.Path"></see> has not been set or is invalid.</exception>
137 <member name="M:System.IO.FileSystemWatcher.EndInit">
138 <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>
140 <member name="E:System.IO.FileSystemWatcher.Error">
141 <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>
143 <member name="P:System.IO.FileSystemWatcher.Filter">
144 <summary>Gets or sets the filter string used to determine what files are monitored in a directory.</summary>
145 <returns>The filter string. The default is &quot;*.*&quot; (Watches all files.)</returns>
147 <member name="P:System.IO.FileSystemWatcher.IncludeSubdirectories">
148 <summary>Gets or sets a value indicating whether subdirectories within the specified path should be monitored.</summary>
149 <returns>true if you want to monitor subdirectories; otherwise, false. The default is false.</returns>
151 <member name="P:System.IO.FileSystemWatcher.InternalBufferSize">
152 <summary>Gets or sets the size (in bytes) of the internal buffer.</summary>
153 <returns>The internal buffer size in bytes. The default is 8192 (8 KB).</returns>
155 <member name="P:System.IO.FileSystemWatcher.NotifyFilter">
156 <summary>Gets or sets the type of changes to watch for.</summary>
157 <returns>One of the <see cref="System.IO.NotifyFilters"></see> values. The default is the bitwise OR combination of LastWrite, FileName, and DirectoryName.</returns>
158 <exception cref="T:System.ArgumentException">The value is not a valid bitwise OR combination of the <see cref="System.IO.NotifyFilters"></see> values.</exception>
159 <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value that is being set is not valid.</exception>
161 <member name="M:System.IO.FileSystemWatcher.OnChanged(System.IO.FileSystemEventArgs)">
162 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Changed"></see> event.</summary>
163 <param name="e">A <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
165 <member name="M:System.IO.FileSystemWatcher.OnCreated(System.IO.FileSystemEventArgs)">
166 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Created"></see> event.</summary>
167 <param name="e">A <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
169 <member name="M:System.IO.FileSystemWatcher.OnDeleted(System.IO.FileSystemEventArgs)">
170 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Deleted"></see> event.</summary>
171 <param name="e">A <see cref="T:System.IO.FileSystemEventArgs"></see> that contains the event data.</param>
173 <member name="M:System.IO.FileSystemWatcher.OnError(System.IO.ErrorEventArgs)">
174 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Error"></see> event.</summary>
175 <param name="e">An <see cref="T:System.IO.ErrorEventArgs"></see> that contains the event data.</param>
177 <member name="M:System.IO.FileSystemWatcher.OnRenamed(System.IO.RenamedEventArgs)">
178 <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Renamed"></see> event.</summary>
179 <param name="e">A <see cref="T:System.IO.RenamedEventArgs"></see> that contains the event data.</param>
181 <member name="P:System.IO.FileSystemWatcher.Path">
182 <summary>Gets or sets the path of the directory to watch.</summary>
183 <returns>The path to monitor. The default is an empty string (&quot;&quot;).</returns>
184 <exception cref="T:System.ArgumentException">The specified path does not exist or could not be found.
186 The specified path contains wildcard characters.
188 The specified path contains invalid path characters.</exception>
190 <member name="E:System.IO.FileSystemWatcher.Renamed">
191 <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path"></see> is renamed.</summary>
193 <member name="P:System.IO.FileSystemWatcher.Site">
194 <summary>Gets or sets an <see cref="T:System.ComponentModel.ISite"></see> for the <see cref="T:System.IO.FileSystemWatcher"></see>.</summary>
195 <returns>An <see cref="System.ComponentModel.ISite"></see> for the <see cref="System.IO.FileSystemWatcher"></see>.</returns>
197 <member name="P:System.IO.FileSystemWatcher.SynchronizingObject">
198 <summary>Gets or sets the object used to marshal the event handler calls issued as a result of a directory change.</summary>
199 <returns>The <see cref="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>
201 <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)">
202 <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>
203 <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes"></see> to watch for.</param>
204 <returns>A <see cref="System.IO.WaitForChangedResult"></see> that contains specific information on the change that occurred.</returns>
206 <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes,System.Int32)">
207 <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>
208 <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes"></see> to watch for.</param>
209 <param name="timeout">The time (in milliseconds) to wait before timing out.</param>
210 <returns>A <see cref="System.IO.WaitForChangedResult"></see> that contains specific information on the change that occurred.</returns>
212 <member name="T:System.IO.InternalBufferOverflowException">
213 <summary>The exception thrown when the internal buffer overflows.</summary>
215 <member name="M:System.IO.InternalBufferOverflowException.#ctor">
216 <summary>Initializes a new default instance of the <see cref="T:System.IO.InternalBufferOverflowException"></see> class.</summary>
218 <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String)">
219 <summary>Initializes a new instance of the <see cref="T:System.IO.InternalBufferOverflowException"></see> class with the error message to be displayed specified.</summary>
220 <param name="message">The message to be given for the exception.</param>
222 <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
223 <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>
224 <param name="info">The information required to serialize the T:System.IO.InternalBufferOverflowException object.</param>
225 <param name="context">The source and destination of the serialized stream associated with the T:System.IO.InternalBufferOverflowException object.</param>
227 <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String,System.Exception)">
228 <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>
229 <param name="message">The message to be given for the exception.</param>
230 <param name="inner">The inner exception.</param>
232 <member name="T:System.IO.RenamedEventArgs">
233 <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Renamed"></see> event.</summary>
235 <member name="M:System.IO.RenamedEventArgs.#ctor(System.IO.WatcherChangeTypes,System.String,System.String,System.String)">
236 <summary>Initializes a new instance of the <see cref="T:System.IO.RenamedEventArgs"></see> class.</summary>
237 <param name="changeType">One of the <see cref="T:System.IO.WatcherChangeTypes"></see> values.</param>
238 <param name="directory">The name of the affected file or directory.</param>
239 <param name="name">The name of the affected file or directory.</param>
240 <param name="oldName">The old name of the affected file or directory.</param>
242 <member name="P:System.IO.RenamedEventArgs.OldFullPath">
243 <summary>Gets the previous fully qualified path of the affected file or directory.</summary>
244 <returns>The previous fully qualified path of the affected file or directory.</returns>
246 <member name="P:System.IO.RenamedEventArgs.OldName">
247 <summary>Gets the old name of the affected file or directory.</summary>
248 <returns>The previous name of the affected file or directory.</returns>
250 <member name="T:System.IO.RenamedEventHandler">
251 <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>
252 <param name="sender">The source of the event.</param>
253 <param name="e">The <see cref="T:System.IO.RenamedEventArgs"></see> that contains the event data.</param>
255 <member name="T:System.IO.WaitForChangedResult">
256 <summary>Contains information on the change that occurred.</summary>
258 <member name="P:System.IO.WaitForChangedResult.ChangeType">
259 <summary>Gets or sets the type of change that occurred.</summary>
260 <returns>One of the <see cref="System.IO.WatcherChangeTypes"></see> values.</returns>
262 <member name="P:System.IO.WaitForChangedResult.Name">
263 <summary>Gets or sets the name of the file or directory that changed.</summary>
264 <returns>The name of the file or directory that changed.</returns>
266 <member name="P:System.IO.WaitForChangedResult.OldName">
267 <summary>Gets or sets the original name of the file or directory that was renamed.</summary>
268 <returns>The original name of the file or directory that was renamed.</returns>
270 <member name="P:System.IO.WaitForChangedResult.TimedOut">
271 <summary>Gets or sets a value indicating whether the wait operation timed out.</summary>
272 <returns>true if the <see cref="System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)"></see> method timed out; otherwise, false.</returns>
274 <member name="T:System.IO.WatcherChangeTypes">
275 <summary>Changes that might occur to a file or directory.</summary>
277 <member name="F:System.IO.WatcherChangeTypes.All">
278 <summary>The creation, deletion, change, or renaming of a file or folder.</summary>
281 <member name="F:System.IO.WatcherChangeTypes.Changed">
282 <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>
285 <member name="F:System.IO.WatcherChangeTypes.Created">
286 <summary>The creation of a file or folder.</summary>
289 <member name="F:System.IO.WatcherChangeTypes.Deleted">
290 <summary>The deletion of a file or folder.</summary>
293 <member name="F:System.IO.WatcherChangeTypes.Renamed">
294 <summary>The renaming of a file or folder.</summary>