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="E:System.IO.FileSystemWatcher.Changed">
  53       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is changed.</summary>
  54     </member>
  55     <member name="E:System.IO.FileSystemWatcher.Created">
  56       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is created.</summary>
  57     </member>
  58     <member name="E:System.IO.FileSystemWatcher.Deleted">
  59       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is deleted.</summary>
  60     </member>
  61     <member name="E:System.IO.FileSystemWatcher.Error">
  62       <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>
  63     </member>
  64     <member name="E:System.IO.FileSystemWatcher.Renamed">
  65       <summary>Occurs when a file or directory in the specified <see cref="P:System.IO.FileSystemWatcher.Path" /> is renamed.</summary>
  66     </member>
  67     <member name="M:System.IO.FileSystemWatcher.#ctor">
  68       <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher" /> class.</summary>
  69     </member>
  70     <member name="M:System.IO.FileSystemWatcher.#ctor(System.String)">
  71       <summary>Initializes a new instance of the <see cref="T:System.IO.FileSystemWatcher" /> class, given the specified directory to monitor.</summary>
  72       <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
  73       <exception cref="T:System.ArgumentNullException">The <paramref name="path" /> parameter is <see langword="null" />.</exception>
  74       <exception cref="T:System.ArgumentException">The <paramref name="path" /> parameter is an empty string ("").
  75
  76  -or-
  77
  78  The path specified through the <paramref name="path" /> parameter does not exist.</exception>
  79       <exception cref="T:System.IO.PathTooLongException">
  80         <paramref name="path" /> is too long.</exception>
  81     </member>
  82     <member name="M:System.IO.FileSystemWatcher.#ctor(System.String,System.String)">
  83       <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>
  84       <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
  85       <param name="filter">The type of files to watch. For example, "*.txt" watches for changes to all text files.</param>
  86       <exception cref="T:System.ArgumentNullException">The <paramref name="path" /> parameter is <see langword="null" />.
  87
  88  -or-
  89
  90  The <paramref name="filter" /> parameter is <see langword="null" />.</exception>
  91       <exception cref="T:System.ArgumentException">The <paramref name="path" /> parameter is an empty string ("").
  92
  93  -or-
  94
  95  The path specified through the <paramref name="path" /> parameter does not exist.</exception>
  96       <exception cref="T:System.IO.PathTooLongException">
  97         <paramref name="path" /> is too long.</exception>
  98     </member>
  99     <member name="M:System.IO.FileSystemWatcher.BeginInit">
 100       <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>
 101     </member>
 102     <member name="M:System.IO.FileSystemWatcher.Dispose(System.Boolean)">
 103       <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.FileSystemWatcher" /> and optionally releases the managed resources.</summary>
 104       <param name="disposing">
 105         <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
 106     </member>
 107     <member name="M:System.IO.FileSystemWatcher.EndInit">
 108       <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>
 109     </member>
 110     <member name="M:System.IO.FileSystemWatcher.OnChanged(System.IO.FileSystemEventArgs)">
 111       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Changed" /> event.</summary>
 112       <param name="e">A <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
 113     </member>
 114     <member name="M:System.IO.FileSystemWatcher.OnCreated(System.IO.FileSystemEventArgs)">
 115       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Created" /> event.</summary>
 116       <param name="e">A <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
 117     </member>
 118     <member name="M:System.IO.FileSystemWatcher.OnDeleted(System.IO.FileSystemEventArgs)">
 119       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Deleted" /> event.</summary>
 120       <param name="e">A <see cref="T:System.IO.FileSystemEventArgs" /> that contains the event data.</param>
 121     </member>
 122     <member name="M:System.IO.FileSystemWatcher.OnError(System.IO.ErrorEventArgs)">
 123       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Error" /> event.</summary>
 124       <param name="e">An <see cref="T:System.IO.ErrorEventArgs" /> that contains the event data.</param>
 125     </member>
 126     <member name="M:System.IO.FileSystemWatcher.OnRenamed(System.IO.RenamedEventArgs)">
 127       <summary>Raises the <see cref="E:System.IO.FileSystemWatcher.Renamed" /> event.</summary>
 128       <param name="e">A <see cref="T:System.IO.RenamedEventArgs" /> that contains the event data.</param>
 129     </member>
 130     <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)">
 131       <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>
 132       <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes" /> to watch for.</param>
 133       <returns>A <see cref="T:System.IO.WaitForChangedResult" /> that contains specific information on the change that occurred.</returns>
 134     </member>
 135     <member name="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes,System.Int32)">
 136       <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>
 137       <param name="changeType">The <see cref="T:System.IO.WatcherChangeTypes" /> to watch for.</param>
 138       <param name="timeout">The time (in milliseconds) to wait before timing out.</param>
 139       <returns>A <see cref="T:System.IO.WaitForChangedResult" /> that contains specific information on the change that occurred.</returns>
 140     </member>
 141     <member name="P:System.IO.FileSystemWatcher.EnableRaisingEvents">
 142       <summary>Gets or sets a value indicating whether the component is enabled.</summary>
 143       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.FileSystemWatcher" /> object has been disposed.</exception>
 144       <exception cref="T:System.PlatformNotSupportedException">The current operating system is not Microsoft Windows NT or later.</exception>
 145       <exception cref="T:System.IO.FileNotFoundException">The directory specified in <see cref="P:System.IO.FileSystemWatcher.Path" /> could not be found.</exception>
 146       <exception cref="T:System.ArgumentException">
 147         <see cref="P:System.IO.FileSystemWatcher.Path" /> has not been set or is invalid.</exception>
 148       <returns>
 149         <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>
 150     </member>
 151     <member name="P:System.IO.FileSystemWatcher.Filter">
 152       <summary>Gets or sets the filter string used to determine what files are monitored in a directory.</summary>
 153       <returns>The filter string. The default is "*.*" (Watches all files.)</returns>
 154     </member>
 155     <member name="P:System.IO.FileSystemWatcher.Filters">
 156       <summary>Gets the collection of all the filters used to determine what files are monitored in a directory.</summary>
 157       <returns>A filter collection.</returns>
 158     </member>
 159     <member name="P:System.IO.FileSystemWatcher.IncludeSubdirectories">
 160       <summary>Gets or sets a value indicating whether subdirectories within the specified path should be monitored.</summary>
 161       <returns>
 162         <see langword="true" /> if you want to monitor subdirectories; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
 163     </member>
 164     <member name="P:System.IO.FileSystemWatcher.InternalBufferSize">
 165       <summary>Gets or sets the size (in bytes) of the internal buffer.</summary>
 166       <returns>The internal buffer size in bytes. The default is 8192 (8 KB).</returns>
 167     </member>
 168     <member name="P:System.IO.FileSystemWatcher.NotifyFilter">
 169       <summary>Gets or sets the type of changes to watch for.</summary>
 170       <exception cref="T:System.ArgumentException">The value is not a valid bitwise OR combination of the <see cref="T:System.IO.NotifyFilters" /> values.</exception>
 171       <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value that is being set is not valid.</exception>
 172       <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>
 173     </member>
 174     <member name="P:System.IO.FileSystemWatcher.Path">
 175       <summary>Gets or sets the path of the directory to watch.</summary>
 176       <exception cref="T:System.ArgumentException">The specified path does not exist or could not be found.
 177
 178  -or-
 179
 180  The specified path contains wildcard characters.
 181
 182  -or-
 183
 184  The specified path contains invalid path characters.</exception>
 185       <returns>The path to monitor. The default is an empty string ("").</returns>
 186     </member>
 187     <member name="P:System.IO.FileSystemWatcher.Site">
 188       <summary>Gets or sets an <see cref="T:System.ComponentModel.ISite" /> for the <see cref="T:System.IO.FileSystemWatcher" />.</summary>
 189       <returns>An <see cref="T:System.ComponentModel.ISite" /> for the <see cref="T:System.IO.FileSystemWatcher" />.</returns>
 190     </member>
 191     <member name="P:System.IO.FileSystemWatcher.SynchronizingObject">
 192       <summary>Gets or sets the object used to marshal the event handler calls issued as a result of a directory change.</summary>
 193       <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>
 194     </member>
 195     <member name="T:System.IO.InternalBufferOverflowException">
 196       <summary>The exception thrown when the internal buffer overflows.</summary>
 197     </member>
 198     <member name="M:System.IO.InternalBufferOverflowException.#ctor">
 199       <summary>Initializes a new default instance of the <see cref="T:System.IO.InternalBufferOverflowException" /> class.</summary>
 200     </member>
 201     <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
 202       <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>
 203       <param name="info">The information required to serialize the <see cref="T:System.IO.InternalBufferOverflowException" /> object.</param>
 204       <param name="context">The source and destination of the serialized stream associated with the <see cref="T:System.IO.InternalBufferOverflowException" /> object.</param>
 205     </member>
 206     <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String)">
 207       <summary>Initializes a new instance of the <see cref="T:System.IO.InternalBufferOverflowException" /> class with the error message to be displayed specified.</summary>
 208       <param name="message">The message to be given for the exception.</param>
 209     </member>
 210     <member name="M:System.IO.InternalBufferOverflowException.#ctor(System.String,System.Exception)">
 211       <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>
 212       <param name="message">The message to be given for the exception.</param>
 213       <param name="inner">The inner exception.</param>
 214     </member>
 215     <member name="T:System.IO.NotifyFilters">
 216       <summary>Specifies changes to watch for in a file or folder.</summary>
 217     </member>
 218     <member name="F:System.IO.NotifyFilters.Attributes">
 219       <summary>The attributes of the file or folder.</summary>
 220     </member>
 221     <member name="F:System.IO.NotifyFilters.CreationTime">
 222       <summary>The time the file or folder was created.</summary>
 223     </member>
 224     <member name="F:System.IO.NotifyFilters.DirectoryName">
 225       <summary>The name of the directory.</summary>
 226     </member>
 227     <member name="F:System.IO.NotifyFilters.FileName">
 228       <summary>The name of the file.</summary>
 229     </member>
 230     <member name="F:System.IO.NotifyFilters.LastAccess">
 231       <summary>The date the file or folder was last opened.</summary>
 232     </member>
 233     <member name="F:System.IO.NotifyFilters.LastWrite">
 234       <summary>The date the file or folder last had anything written to it.</summary>
 235     </member>
 236     <member name="F:System.IO.NotifyFilters.Security">
 237       <summary>The security settings of the file or folder.</summary>
 238     </member>
 239     <member name="F:System.IO.NotifyFilters.Size">
 240       <summary>The size of the file or folder.</summary>
 241     </member>
 242     <member name="T:System.IO.RenamedEventArgs">
 243       <summary>Provides data for the <see cref="E:System.IO.FileSystemWatcher.Renamed" /> event.</summary>
 244     </member>
 245     <member name="M:System.IO.RenamedEventArgs.#ctor(System.IO.WatcherChangeTypes,System.String,System.String,System.String)">
 246       <summary>Initializes a new instance of the <see cref="T:System.IO.RenamedEventArgs" /> class.</summary>
 247       <param name="changeType">One of the <see cref="T:System.IO.WatcherChangeTypes" /> values.</param>
 248       <param name="directory">The name of the affected file or directory.</param>
 249       <param name="name">The name of the affected file or directory.</param>
 250       <param name="oldName">The old name of the affected file or directory.</param>
 251     </member>
 252     <member name="P:System.IO.RenamedEventArgs.OldFullPath">
 253       <summary>Gets the previous fully qualified path of the affected file or directory.</summary>
 254       <returns>The previous fully qualified path of the affected file or directory.</returns>
 255     </member>
 256     <member name="P:System.IO.RenamedEventArgs.OldName">
 257       <summary>Gets the old name of the affected file or directory.</summary>
 258       <returns>The previous name of the affected file or directory.</returns>
 259     </member>
 260     <member name="T:System.IO.RenamedEventHandler">
 261       <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>
 262       <param name="sender">The source of the event.</param>
 263       <param name="e">The <see cref="T:System.IO.RenamedEventArgs" /> that contains the event data.</param>
 264     </member>
 265     <member name="T:System.IO.WaitForChangedResult">
 266       <summary>Contains information on the change that occurred.</summary>
 267     </member>
 268     <member name="P:System.IO.WaitForChangedResult.ChangeType">
 269       <summary>Gets or sets the type of change that occurred.</summary>
 270       <returns>One of the <see cref="T:System.IO.WatcherChangeTypes" /> values.</returns>
 271     </member>
 272     <member name="P:System.IO.WaitForChangedResult.Name">
 273       <summary>Gets or sets the name of the file or directory that changed.</summary>
 274       <returns>The name of the file or directory that changed.</returns>
 275     </member>
 276     <member name="P:System.IO.WaitForChangedResult.OldName">
 277       <summary>Gets or sets the original name of the file or directory that was renamed.</summary>
 278       <returns>The original name of the file or directory that was renamed.</returns>
 279     </member>
 280     <member name="P:System.IO.WaitForChangedResult.TimedOut">
 281       <summary>Gets or sets a value indicating whether the wait operation timed out.</summary>
 282       <returns>
 283         <see langword="true" /> if the <see cref="M:System.IO.FileSystemWatcher.WaitForChanged(System.IO.WatcherChangeTypes)" /> method timed out; otherwise, <see langword="false" />.</returns>
 284     </member>
 285     <member name="T:System.IO.WatcherChangeTypes">
 286       <summary>Changes that might occur to a file or directory.</summary>
 287     </member>
 288     <member name="F:System.IO.WatcherChangeTypes.All">
 289       <summary>The creation, deletion, change, or renaming of a file or folder.</summary>
 290     </member>
 291     <member name="F:System.IO.WatcherChangeTypes.Changed">
 292       <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>
 293     </member>
 294     <member name="F:System.IO.WatcherChangeTypes.Created">
 295       <summary>The creation of a file or folder.</summary>
 296     </member>
 297     <member name="F:System.IO.WatcherChangeTypes.Deleted">
 298       <summary>The deletion of a file or folder.</summary>
 299     </member>
 300     <member name="F:System.IO.WatcherChangeTypes.Renamed">
 301       <summary>The renaming of a file or folder.</summary>
 302     </member>
 303   </members>
 304 </doc>