Revert "PR-5360"
[platform/core/csapi/tizenfx.git] / pkg / Tizen.NET.API11 / build / tizen11.0 / ref / System.IO.FileSystem.Watcher.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <doc>
3   <assembly>
4     <name>System.IO.FileSystem.Watcher</name>
5   </assembly>
6   <members>
7     <member name="T:System.IO.ErrorEventArgs">
8       <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Error" /> event.</summary>
9     </member>
10     <member name="M:System.IO.ErrorEventArgs.#ctor(System.Exception)">
11       <summary>Initializes a new instance of the <see cref="T:System.IO.ErrorEventArgs" /> class.</summary>
12       <param name="exception">An <see cref="T:System.Exception" /> that represents the error that occurred.</param>
13     </member>
14     <member name="M:System.IO.ErrorEventArgs.GetException">
15       <summary>Gets the <see cref="T:System.Exception" /> that represents the error that occurred.</summary>
16       <returns>An <see cref="T:System.Exception" /> that represents the error that occurred.</returns>
17     </member>
18     <member name="T:System.IO.ErrorEventHandler">
19       <summary>Represents the method that will handle the <see cref="E:System.IO.FileSystemWatcher.Error" /> event of a <see cref="T:System.IO.FileSystemWatcher" /> object.</summary>
20       <param name="sender">The source of the event.</param>
21       <param name="e">An <see cref="T:System.IO.ErrorEventArgs" /> object that contains the event data.</param>
22     </member>
23     <member name="T:System.IO.FileSystemEventArgs">
24       <summary>Provides data for the directory events: <see cref="E:System.IO.FileSystemWatcher.Changed" />, <see cref="E:System.IO.FileSystemWatcher.Created" />, <see cref="E:System.IO.FileSystemWatcher.Deleted" />.</summary>
25     </member>
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" /> class.</summary>
28       <param name="changeType">One of the <see cref="T:System.IO.WatcherChangeTypes" /> 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>
31     </member>
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" /> values that represents the kind of change detected in the file system.</returns>
35     </member>
36     <member name="P:System.IO.FileSystemEventArgs.FullPath">
37       <summary>Gets the fully qualified path of the affected file or directory.</summary>
38       <returns>The path of the affected file or directory.</returns>
39     </member>
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>
43     </member>
44     <member name="T:System.IO.FileSystemEventHandler">
45       <summary>Represents the method that will handle the <see cref="E:System.IO.FileSystemWatcher.Changed" />, <see cref="E:System.IO.FileSystemWatcher.Created" />, or <see cref="E:System.IO.FileSystemWatcher.Deleted" /> event of a <see cref="T:System.IO.FileSystemWatcher" /> class.</summary>
46       <param name="sender">The source of the event.</param>
47       <param name="e">The <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
48     </member>
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>
51     </member>
52     <member name="M:System.IO.FileSystemWatcher.#ctor">
53       <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher" /> class.</summary>
54     </member>
55     <member name="M:System.IO.FileSystemWatcher.#ctor(System.String)">
56       <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher" /> 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" /> parameter is <see langword="null" />.</exception>
59       <exception cref="T:System.ArgumentException">The <paramref name="path" /> parameter is an empty string ("").
60 -or-
61 The path specified through the <paramref name="path" /> parameter does not exist.</exception>
62       <exception cref="T:System.IO.PathTooLongException">
63         <paramref name="path" /> is too long.</exception>
64     </member>
65     <member name="M:System.IO.FileSystemWatcher.#ctor(System.String,System.String)">
66       <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher" /> class, given the specified directory and type of files to monitor.</summary>
67       <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
68       <param name="filter">The type of files to watch. For example, "*.txt" watches for changes to all text files.</param>
69       <exception cref="T:System.ArgumentNullException">The <paramref name="path" /> parameter is <see langword="null" />.
70 -or-
71 The <paramref name="filter" /> parameter is <see langword="null" />.</exception>
72       <exception cref="T:System.ArgumentException">The <paramref name="path" /> parameter is an empty string ("").
73 -or-
74 The path specified through the <paramref name="path" /> parameter does not exist.</exception>
75       <exception cref="T:System.IO.PathTooLongException">
76         <paramref name="path" /> is too long.</exception>
77     </member>
78     <member name="M:System.IO.FileSystemWatcher.BeginInit">
79       <summary>Begins the initialization of a <see cref="T:System.IO.FileSystemWatcher" /> used on a form or used by another component. The initialization occurs at run time.</summary>
80     </member>
81     <member name="E:System.IO.FileSystemWatcher.Changed">
82       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is changed.</summary>
83     </member>
84     <member name="E:System.IO.FileSystemWatcher.Created">
85       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is created.</summary>
86     </member>
87     <member name="E:System.IO.FileSystemWatcher.Deleted">
88       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is deleted.</summary>
89     </member>
90     <member name="M:System.IO.FileSystemWatcher.Dispose(System.Boolean)">
91       <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.FileSystemWatcher" /> and optionally releases the managed resources.</summary>
92       <param name="disposing">
93         <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
94     </member>
95     <member name="P:System.IO.FileSystemWatcher.EnableRaisingEvents">
96       <summary>Gets or sets a value indicating whether the component is enabled.</summary>
97       <returns>
98         <see langword="true" /> if the component is enabled; otherwise, <see langword="false" />. The default is <see langword="false" />. If you are using the component on a designer in Visual Studio 2005, the default is <see langword="true" />.</returns>
99       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.FileSystemWatcher" /> object has been disposed.</exception>
100       <exception cref="T:System.PlatformNotSupportedException">The current operating system is not Microsoft Windows NT or later.</exception>
101       <exception cref="T:System.IO.FileNotFoundException">The directory specified in <see cref="P:System.IO.FileSystemWatcher.Path" /> could not be found.</exception>
102       <exception cref="T:System.ArgumentException">
103         <see cref="P:System.IO.FileSystemWatcher.Path" /> has not been set or is invalid.</exception>
104     </member>
105     <member name="M:System.IO.FileSystemWatcher.EndInit">
106       <summary>Ends the initialization of a <see cref="T:System.IO.FileSystemWatcher" /> used on a form or used by another component. The initialization occurs at run time.</summary>
107     </member>
108     <member name="E:System.IO.FileSystemWatcher.Error">
109       <summary>Occurs when the instance of <see cref="T:System.IO.FileSystemWatcher" /> is unable to continue monitoring changes or when the internal buffer overflows.</summary>
110     </member>
111     <member name="P:System.IO.FileSystemWatcher.Filter">
112       <summary>Gets or sets the filter string used to determine what files are monitored in a directory.</summary>
113       <returns>The filter string. The default is "*.*" (Watches all files.)</returns>
114     </member>
115     <member name="P:System.IO.FileSystemWatcher.Filters">
116       <summary>Gets the collection of all the filters used to determine what files are monitored in a directory.</summary>
117       <returns>A filter collection.</returns>
118     </member>
119     <member name="P:System.IO.FileSystemWatcher.IncludeSubdirectories">
120       <summary>Gets or sets a value indicating whether subdirectories within the specified path should be monitored.</summary>
121       <returns>
122         <see langword="true" /> if you want to monitor subdirectories; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
123     </member>
124     <member name="P:System.IO.FileSystemWatcher.InternalBufferSize">
125       <summary>Gets or sets the size (in bytes) of the internal buffer.</summary>
126       <returns>The internal buffer size in bytes. The default is 8192 (8 KB).</returns>
127     </member>
128     <member name="P:System.IO.FileSystemWatcher.NotifyFilter">
129       <summary>Gets or sets the type of changes to watch for.</summary>
130       <returns>One of the <see cref="T:System.IO.NotifyFilters" /> values. The default is the bitwise OR combination of <see langword="LastWrite" />, <see langword="FileName" />, and <see langword="DirectoryName" />.</returns>
131       <exception cref="T:System.ArgumentException">The value is not a valid bitwise OR combination of the <see cref="T:System.IO.NotifyFilters" /> values.</exception>
132       <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value that is being set is not valid.</exception>
133     </member>
134     <member name="M:System.IO.FileSystemWatcher.OnChanged(System.IO.FileSystemEventArgs)">
135       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Changed" /> event.</summary>
136       <param name="e">A <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
137     </member>
138     <member name="M:System.IO.FileSystemWatcher.OnCreated(System.IO.FileSystemEventArgs)">
139       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Created" /> event.</summary>
140       <param name="e">A <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
141     </member>
142     <member name="M:System.IO.FileSystemWatcher.OnDeleted(System.IO.FileSystemEventArgs)">
143       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Deleted" /> event.</summary>
144       <param name="e">A <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
145     </member>
146     <member name="M:System.IO.FileSystemWatcher.OnError(System.IO.ErrorEventArgs)">
147       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Error" /> event.</summary>
148       <param name="e">An <see cref="T:System.IO.ErrorEventArgs" /> that contains the event data.</param>
149     </member>
150     <member name="M:System.IO.FileSystemWatcher.OnRenamed(System.IO.RenamedEventArgs)">
151       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Renamed" /> event.</summary>
152       <param name="e">A <see cref="T:System.IO.RenamedEventArgs" /> that contains the event data.</param>
153     </member>
154     <member name="P:System.IO.FileSystemWatcher.Path">
155       <summary>Gets or sets the path of the directory to watch.</summary>
156       <returns>The path to monitor. The default is an empty string ("").</returns>
157       <exception cref="T:System.ArgumentException">The specified path does not exist or could not be found.
158 -or-
159 The specified path contains wildcard characters.
160 -or-
161 The specified path contains invalid path characters.</exception>
162     </member>
163     <member name="E:System.IO.FileSystemWatcher.Renamed">
164       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is renamed.</summary>
165     </member>
166     <member name="P:System.IO.FileSystemWatcher.Site">
167       <summary>Gets or sets an <see cref="T:System.ComponentModel.ISite" /> for the <see cref="T:System.IO.FileSystemWatcher" />.</summary>
168       <returns>An <see cref="T:System.ComponentModel.ISite" /> for the <see cref="T:System.IO.FileSystemWatcher" />.</returns>
169     </member>
170     <member name="P:System.IO.FileSystemWatcher.SynchronizingObject">
171       <summary>Gets or sets the object used to marshal the event handler calls issued as a result of a directory change.</summary>
172       <returns>The <see cref="T:System.ComponentModel.ISynchronizeInvoke" /> that represents the object used to marshal the event handler calls issued as a result of a directory change. The default is <see langword="null" />.</returns>
173     </member>
174     <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)">
175       <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>
176       <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes" /> to watch for.</param>
177       <returns>A <see cref="T:System.IO.WaitForChangedResult" /> that contains specific information on the change that occurred.</returns>
178     </member>
179     <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes,System.Int32)">
180       <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>
181       <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes" /> to watch for.</param>
182       <param name="timeout">The time (in milliseconds) to wait before timing out.</param>
183       <returns>A <see cref="T:System.IO.WaitForChangedResult" /> that contains specific information on the change that occurred.</returns>
184     </member>
185     <member name="T:System.IO.InternalBufferOverflowException">
186       <summary>The exception thrown when the internal buffer overflows.</summary>
187     </member>
188     <member name="M:System.IO.InternalBufferOverflowException.#ctor">
189       <summary>Initializes a new default instance of the <see cref="T:System.IO.InternalBufferOverflowException" /> class.</summary>
190     </member>
191     <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
192       <summary>Initializes a new, empty instance of the <see cref="T:System.IO.InternalBufferOverflowException" /> class that is serializable using the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" /> objects.</summary>
193       <param name="info">The information required to serialize the T:System.IO.InternalBufferOverflowException object.</param>
194       <param name="context">The source and destination of the serialized stream associated with the T:System.IO.InternalBufferOverflowException object.</param>
195     </member>
196     <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String)">
197       <summary>Initializes a new instance of the <see cref="T:System.IO.InternalBufferOverflowException" /> class with the error message to be displayed specified.</summary>
198       <param name="message">The message to be given for the exception.</param>
199     </member>
200     <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String,System.Exception)">
201       <summary>Initializes a new instance of the <see cref="T:System.IO.InternalBufferOverflowException" /> class with the message to be displayed and the generated inner exception specified.</summary>
202       <param name="message">The message to be given for the exception.</param>
203       <param name="inner">The inner exception.</param>
204     </member>
205     <member name="T:System.IO.NotifyFilters">
206       <summary>Specifies changes to watch for in a file or folder.</summary>
207     </member>
208     <member name="F:System.IO.NotifyFilters.Attributes">
209       <summary>The attributes of the file or folder.</summary>
210     </member>
211     <member name="F:System.IO.NotifyFilters.CreationTime">
212       <summary>The time the file or folder was created.</summary>
213     </member>
214     <member name="F:System.IO.NotifyFilters.DirectoryName">
215       <summary>The name of the directory.</summary>
216     </member>
217     <member name="F:System.IO.NotifyFilters.FileName">
218       <summary>The name of the file.</summary>
219     </member>
220     <member name="F:System.IO.NotifyFilters.LastAccess">
221       <summary>The date the file or folder was last opened.</summary>
222     </member>
223     <member name="F:System.IO.NotifyFilters.LastWrite">
224       <summary>The date the file or folder last had anything written to it.</summary>
225     </member>
226     <member name="F:System.IO.NotifyFilters.Security">
227       <summary>The security settings of the file or folder.</summary>
228     </member>
229     <member name="F:System.IO.NotifyFilters.Size">
230       <summary>The size of the file or folder.</summary>
231     </member>
232     <member name="T:System.IO.RenamedEventArgs">
233       <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Renamed" /> event.</summary>
234     </member>
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" /> class.</summary>
237       <param name="changeType">One of the <see cref="T:System.IO.WatcherChangeTypes" /> 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>
241     </member>
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>
245     </member>
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>
249     </member>
250     <member name="T:System.IO.RenamedEventHandler">
251       <summary>Represents the method that will handle the <see cref="E:System.IO.FileSystemWatcher.Renamed" /> event of a <see cref="T:System.IO.FileSystemWatcher" /> class.</summary>
252       <param name="sender">The source of the event.</param>
253       <param name="e">The <see cref="T:System.IO.RenamedEventArgs" /> that contains the event data.</param>
254     </member>
255     <member name="T:System.IO.WaitForChangedResult">
256       <summary>Contains information on the change that occurred.</summary>
257     </member>
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="T:System.IO.WatcherChangeTypes" /> values.</returns>
261     </member>
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>
265     </member>
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>
269     </member>
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>
273         <see langword="true" /> if the <see cref="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)" /> method timed out; otherwise, <see langword="false" />.</returns>
274     </member>
275     <member name="T:System.IO.WatcherChangeTypes">
276       <summary>Changes that might occur to a file or directory.</summary>
277     </member>
278     <member name="F:System.IO.WatcherChangeTypes.All">
279       <summary>The creation, deletion, change, or renaming of a file or folder.</summary>
280     </member>
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>
283     </member>
284     <member name="F:System.IO.WatcherChangeTypes.Created">
285       <summary>The creation of a file or folder.</summary>
286     </member>
287     <member name="F:System.IO.WatcherChangeTypes.Deleted">
288       <summary>The deletion of a file or folder.</summary>
289     </member>
290     <member name="F:System.IO.WatcherChangeTypes.Renamed">
291       <summary>The renaming of a file or folder.</summary>
292     </member>
293   </members>
294 </doc>