pkg/Tizen.NET.API11/build/tizen11.0/ref/System.IO.MemoryMappedFiles.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <doc>
   3   <assembly>
   4     <name>System.IO.MemoryMappedFiles</name>
   5   </assembly>
   6   <members>
   7     <member name="T:Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle">
   8       <summary>Provides a safe handle that represents a memory-mapped file for sequential access.</summary>
   9     </member>
  10     <member name="M:Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle.#ctor">
  11       <summary>Creates a <see cref="T:Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle" />.</summary>
  12     </member>
  13     <member name="P:Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle.IsInvalid">
  14       <summary>Gets a value that indicates whether the handle is invalid.</summary>
  15       <returns>
  16         <see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</returns>
  17     </member>
  18     <member name="T:Microsoft.Win32.SafeHandles.SafeMemoryMappedViewHandle">
  19       <summary>Provides a safe handle that represents a view of a block of unmanaged memory for random access.</summary>
  20     </member>
  21     <member name="M:Microsoft.Win32.SafeHandles.SafeMemoryMappedViewHandle.#ctor">
  22       <summary>Initializes a <see cref="T:Microsoft.Win32.SafeHandles.SafeMemoryMappedViewHandle" /> instance.</summary>
  23     </member>
  24     <member name="T:System.IO.MemoryMappedFiles.MemoryMappedFile">
  25       <summary>Represents a memory-mapped file.</summary>
  26     </member>
  27     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateFromFile(System.IO.FileStream,System.String,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess,System.IO.HandleInheritability,System.Boolean)">
  28       <summary>Creates a memory-mapped file from an existing file with the specified access mode, name, inheritability, and capacity.</summary>
  29       <param name="fileStream">The file stream of the existing file.</param>
  30       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
  31       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file. Specify 0 to set the capacity to the size of <c>filestream</c>.</param>
  32       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file.
  33
  34  This parameter can't be set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" />.</param>
  35       <param name="inheritability">One of the enumeration values that specifies whether a handle to the memory-mapped file can be inherited by a child process. The default is <see cref="F:System.IO.HandleInheritability.None" />.</param>
  36       <param name="leaveOpen">A value that indicates whether to close the source file stream when the <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> is disposed.</param>
  37       <exception cref="T:System.ArgumentException">
  38         <paramref name="mapName" /> is <see langword="null" /> or an empty string.
  39
  40  -or-
  41
  42  <paramref name="capacity" /> and the length of the file are zero.
  43
  44  -or-
  45
  46  <paramref name="access" /> is set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> or <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> enumeration value, which is not allowed.
  47
  48  -or-
  49
  50  <paramref name="access" /> is set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Read" /> and <paramref name="capacity" /> is larger than the length of <see langword="filestream" />.</exception>
  51       <exception cref="T:System.ArgumentNullException">
  52         <paramref name="fileStream" /> is <see langword="null" />.</exception>
  53       <exception cref="T:System.ArgumentOutOfRangeException">
  54         <paramref name="capacity" /> is less than zero.
  55
  56  -or-
  57
  58  <paramref name="capacity" /> is less than the file size.
  59
  60  -or-
  61
  62  <paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.
  63
  64  -or-
  65
  66  <paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> enumeration value.</exception>
  67       <returns>A memory-mapped file that has the specified characteristics.</returns>
  68     </member>
  69     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateFromFile(System.String)">
  70       <summary>Creates a memory-mapped file from a file on disk.</summary>
  71       <param name="path">The path to file to map.</param>
  72       <exception cref="T:System.ArgumentException">
  73         <paramref name="path" /> is an empty string, contains only white space, or has one or more invalid characters, as defined by the <see cref="M:System.IO.Path.GetInvalidFileNameChars" /> method.
  74
  75  -or-
  76
  77  <paramref name="path" /> refers to an invalid device.</exception>
  78       <exception cref="T:System.ArgumentNullException">
  79         <paramref name="path" /> is <see langword="null" />.</exception>
  80       <exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
  81       <exception cref="T:System.IO.PathTooLongException">
  82         <paramref name="path" /> exceeds the maximum length defined by the operating system.</exception>
  83       <exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
  84       <returns>A memory-mapped file.</returns>
  85     </member>
  86     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateFromFile(System.String,System.IO.FileMode)">
  87       <summary>Creates a memory-mapped file that has the specified access mode from a file on disk.</summary>
  88       <param name="path">The path to the file to map.</param>
  89       <param name="mode">Access mode; must be <see cref="F:System.IO.FileMode.Open" />.</param>
  90       <exception cref="T:System.ArgumentException">
  91         <paramref name="path" /> is an empty string, contains only white space, or has one or more invalid characters, as defined by the <see cref="M:System.IO.Path.GetInvalidFileNameChars" /> method.
  92
  93  -or-
  94
  95  <paramref name="path" /> refers to an invalid device.
  96
  97  -or-
  98
  99  <paramref name="mode" /> is <see cref="F:System.IO.FileMode.Append" />.</exception>
 100       <exception cref="T:System.ArgumentNullException">
 101         <paramref name="path" /> is <see langword="null" />.</exception>
 102       <exception cref="T:System.IO.IOException">
 103         <paramref name="mode" /> is <see cref="F:System.IO.FileMode.Create" />, <see cref="F:System.IO.FileMode.CreateNew" />, or <see cref="F:System.IO.FileMode.Truncate" />.
 104
 105  -or-
 106
 107  <paramref name="mode" /> is <see cref="F:System.IO.FileMode.OpenOrCreate" /> and the file on disk does not exist.
 108
 109  -or-
 110
 111  An I/O error occurred.</exception>
 112       <exception cref="T:System.IO.PathTooLongException">
 113         <paramref name="path" /> exceeds the maximum length defined by the operating system.</exception>
 114       <exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
 115       <returns>A memory-mapped file that has the specified access mode.</returns>
 116     </member>
 117     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateFromFile(System.String,System.IO.FileMode,System.String)">
 118       <summary>Creates a memory-mapped file that has the specified access mode and name from a file on disk.</summary>
 119       <param name="path">The path to the file to map.</param>
 120       <param name="mode">Access mode; must be <see cref="F:System.IO.FileMode.Open" />.</param>
 121       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
 122       <exception cref="T:System.ArgumentException">
 123         <paramref name="path" /> is an empty string, contains only white space, or has one or more invalid characters, as defined by the <see cref="M:System.IO.Path.GetInvalidFileNameChars" /> method.
 124
 125  -or-
 126
 127  <paramref name="path" /> refers to an invalid device.
 128
 129  -or-
 130
 131  <paramref name="mapName" /> is an empty string.
 132
 133  -or-
 134
 135  <paramref name="mode" /> is <see cref="F:System.IO.FileMode.Append" />.</exception>
 136       <exception cref="T:System.ArgumentNullException">
 137         <paramref name="path" /> is <see langword="null" />.</exception>
 138       <exception cref="T:System.IO.IOException">
 139         <paramref name="mode" /> is <see cref="F:System.IO.FileMode.Create" />, <see cref="F:System.IO.FileMode.CreateNew" />, or <see cref="F:System.IO.FileMode.Truncate" />.
 140
 141  -or-
 142
 143  <paramref name="mode" /> is <see cref="F:System.IO.FileMode.OpenOrCreate" /> and the file on disk does not exist.
 144
 145  -or-
 146
 147  An I/O error occurred.</exception>
 148       <exception cref="T:System.IO.PathTooLongException">
 149         <paramref name="path" /> exceeds the maximum length defined by the operating system.</exception>
 150       <exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
 151       <returns>A memory-mapped file that has the specified name and access mode.</returns>
 152     </member>
 153     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateFromFile(System.String,System.IO.FileMode,System.String,System.Int64)">
 154       <summary>Creates a memory-mapped file that has the specified access mode, name, and capacity from a file on disk.</summary>
 155       <param name="path">The path to the file to map.</param>
 156       <param name="mode">Access mode; can be any of the <see cref="T:System.IO.FileMode" /> enumeration values except <see cref="F:System.IO.FileMode.Append" />.</param>
 157       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
 158       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file. Specify 0 to set the capacity to the size of the file on disk.</param>
 159       <exception cref="T:System.ArgumentException">
 160         <paramref name="path" /> is an empty string, contains only white space, or has one or more invalid characters, as defined by the <see cref="M:System.IO.Path.GetInvalidFileNameChars" /> method.
 161
 162  -or-
 163
 164  <paramref name="path" /> refers to an invalid device.
 165
 166  -or-
 167
 168  <paramref name="mapName" /> is an empty string.
 169
 170  -or-
 171
 172  <paramref name="mode" /> is <see cref="F:System.IO.FileMode.Append" />.</exception>
 173       <exception cref="T:System.ArgumentNullException">
 174         <paramref name="path" /> is <see langword="null" />.</exception>
 175       <exception cref="T:System.ArgumentOutOfRangeException">
 176         <paramref name="capacity" /> is greater than the size of the logical address space.
 177
 178  -or-
 179
 180  <paramref name="capacity" /> is less than zero.
 181
 182  -or-
 183
 184  <paramref name="capacity" /> is less than the file size (but not zero).
 185
 186  -or-
 187
 188  <paramref name="capacity" /> is zero, and the size of the file on disk is also zero.</exception>
 189       <exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
 190       <exception cref="T:System.IO.PathTooLongException">
 191         <paramref name="path" /> exceeds the maximum length defined by the operating system.</exception>
 192       <exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
 193       <returns>A memory-mapped file that has the specified characteristics.</returns>
 194     </member>
 195     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateFromFile(System.String,System.IO.FileMode,System.String,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess)">
 196       <summary>Creates a memory-mapped file that has the specified access mode, name, capacity, and access type from a file on disk.</summary>
 197       <param name="path">The path to the file to map.</param>
 198       <param name="mode">Access mode; can be any of the <see cref="T:System.IO.FileMode" /> enumeration values except <see cref="F:System.IO.FileMode.Append" />.</param>
 199       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
 200       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file. Specify 0 to set the capacity to the size of the file on disk.</param>
 201       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file.</param>
 202       <exception cref="T:System.ArgumentException">
 203         <paramref name="mapName" /> is an empty string.
 204
 205  -or-
 206
 207  <paramref name="access" /> is not an allowed value.
 208
 209  -or-
 210
 211  <paramref name="path" /> specifies an empty file.
 212
 213  -or-
 214
 215  <paramref name="access" /> is specified as <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Read" /> and capacity is greater than the size of the file indicated by <paramref name="path" />.
 216
 217  -or-
 218
 219  <paramref name="mode" /> is <see cref="F:System.IO.FileMode.Append" />.</exception>
 220       <exception cref="T:System.ArgumentNullException">
 221         <paramref name="path" /> is <see langword="null" />.</exception>
 222       <exception cref="T:System.ArgumentOutOfRangeException">
 223         <paramref name="capacity" /> is greater than the size of the logical address space.
 224
 225  -or-
 226
 227  <paramref name="capacity" /> is less than zero.
 228
 229  -or-
 230
 231  <paramref name="capacity" /> is less than the file size (but not zero).
 232
 233  -or-
 234
 235  <paramref name="capacity" /> is zero, and the size of the file on disk is also zero.
 236
 237  -or-
 238
 239  <paramref name="access" /> is not a defined <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> value.
 240
 241  -or-
 242
 243  The size of the file indicated by <paramref name="path" /> is greater than <paramref name="capacity" />.</exception>
 244       <exception cref="T:System.IO.IOException">-or-
 245
 246  An I/O error occurred.</exception>
 247       <exception cref="T:System.IO.PathTooLongException">
 248         <paramref name="path" /> exceeds the maximum length defined by the operating system.</exception>
 249       <exception cref="T:System.Security.SecurityException">The caller does not have the required permissions for the file.</exception>
 250       <returns>A memory-mapped file that has the specified characteristics.</returns>
 251     </member>
 252     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateNew(System.String,System.Int64)">
 253       <summary>Creates a memory-mapped file that has the specified capacity in system memory.</summary>
 254       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
 255       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file.</param>
 256       <exception cref="T:System.ArgumentException">
 257         <paramref name="mapName" /> is an empty string.</exception>
 258       <exception cref="T:System.ArgumentOutOfRangeException">
 259         <paramref name="capacity" /> is less than or equal to zero.</exception>
 260       <exception cref="T:System.PlatformNotSupportedException">.NET Core and .NET 5+ only: Calls to the <c>CreateNew</c> method with a named memory mapped file (that is, a non-null <paramref name="mapName" />) are supported on Windows operating systems only.</exception>
 261       <returns>A memory-mapped file that has the specified name and capacity.</returns>
 262     </member>
 263     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateNew(System.String,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess)">
 264       <summary>Creates a memory-mapped file that has the specified capacity and access type in system memory.</summary>
 265       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
 266       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file.</param>
 267       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />.</param>
 268       <exception cref="T:System.ArgumentException">
 269         <paramref name="mapName" /> is an empty string.
 270
 271  -or-
 272
 273  <paramref name="access" /> is set to write-only with the <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> enumeration value.</exception>
 274       <exception cref="T:System.ArgumentOutOfRangeException">
 275         <paramref name="capacity" /> is less than or equal to zero.
 276
 277  -or-
 278
 279  <paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.</exception>
 280       <exception cref="T:System.PlatformNotSupportedException">.NET Core and .NET 5+ only: Calls to the <c>CreateNew</c> method with a named memory mapped file (that is, a non-null <paramref name="mapName" />) are supported on Windows operating systems only.</exception>
 281       <returns>A memory-mapped file that has the specified characteristics.</returns>
 282     </member>
 283     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateNew(System.String,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess,System.IO.MemoryMappedFiles.MemoryMappedFileOptions,System.IO.HandleInheritability)">
 284       <summary>Creates a memory-mapped file that has the specified name, capacity, access type, memory allocation options and inheritability.</summary>
 285       <param name="mapName">A name to assign to the memory-mapped file, or <see langword="null" /> for a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> that you do not intend to share across processes.</param>
 286       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file.</param>
 287       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />.</param>
 288       <param name="options">A bitwise combination of enumeration values that specifies memory allocation options for the memory-mapped file.</param>
 289       <param name="inheritability">A value that specifies whether a handle to the memory-mapped file can be inherited by a child process. The default is <see cref="F:System.IO.HandleInheritability.None" />.</param>
 290       <exception cref="T:System.ArgumentException">
 291         <paramref name="mapName" /> is an empty string.
 292
 293  -or-
 294
 295  <paramref name="access" /> is set to write-only with the <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> enumeration value.</exception>
 296       <exception cref="T:System.ArgumentOutOfRangeException">
 297         <paramref name="capacity" /> is less than or equal to zero.
 298
 299  -or-
 300
 301  <paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.
 302
 303  -or-
 304
 305  <paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> value.</exception>
 306       <exception cref="T:System.PlatformNotSupportedException">.NET Core and .NET 5+ only: Calls to the <c>CreateNew</c> method with a named memory mapped file (that is, a non-null <paramref name="mapName" />) are supported on Windows operating systems only.</exception>
 307       <returns>A memory-mapped file that has the specified characteristics.</returns>
 308     </member>
 309     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateOrOpen(System.String,System.Int64)">
 310       <summary>Creates or opens a memory-mapped file that has the specified name and capacity in system memory.</summary>
 311       <param name="mapName">The name of the memory-mapped file.</param>
 312       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file.</param>
 313       <exception cref="T:System.ArgumentException">
 314         <paramref name="mapName" /> is an empty string.</exception>
 315       <exception cref="T:System.ArgumentOutOfRangeException">
 316         <paramref name="capacity" /> is greater than the size of the logical address space.
 317
 318  -or-
 319
 320  <paramref name="capacity" /> is less than or equal to zero.</exception>
 321       <returns>A memory-mapped file that has the specified name and size.</returns>
 322     </member>
 323     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateOrOpen(System.String,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess)">
 324       <summary>Creates or opens a memory-mapped file that has the specified name, capacity and access type in system memory.</summary>
 325       <param name="mapName">The name of the memory-mapped file.</param>
 326       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file.</param>
 327       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />.</param>
 328       <exception cref="T:System.ArgumentNullException">
 329         <paramref name="mapName" /> is <see langword="null" />.</exception>
 330       <exception cref="T:System.ArgumentException">
 331         <paramref name="mapName" /> is an empty string.
 332
 333  -or-
 334
 335  <paramref name="access" /> is set to write-only with the <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> enumeration value.</exception>
 336       <exception cref="T:System.ArgumentOutOfRangeException">
 337         <paramref name="capacity" /> is greater than the size of the logical address space.
 338
 339  -or-
 340
 341  <paramref name="capacity" /> is less than or equal to zero.
 342
 343  -or-
 344
 345  <paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.</exception>
 346       <exception cref="T:System.UnauthorizedAccessException">The operating system denied the specified access to the file; for example, access is set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> or <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />, but the file or directory is read-only.</exception>
 347       <returns>A memory-mapped file that has the specified characteristics.</returns>
 348     </member>
 349     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateOrOpen(System.String,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess,System.IO.MemoryMappedFiles.MemoryMappedFileOptions,System.IO.HandleInheritability)">
 350       <summary>Creates a new empty memory mapped file or opens an existing memory mapped file if one exists with the same name. If opening an existing file, the capacity, options, and memory arguments will be ignored.</summary>
 351       <param name="mapName">The name of the memory-mapped file.</param>
 352       <param name="capacity">The maximum size, in bytes, to allocate to the memory-mapped file.</param>
 353       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />.</param>
 354       <param name="options">A bitwise combination of values that indicate the memory allocation options to apply to the file.</param>
 355       <param name="inheritability">A value that specifies whether a handle to the memory-mapped file can be inherited by a child process. The default is <see cref="F:System.IO.HandleInheritability.None" />.</param>
 356       <exception cref="T:System.ArgumentNullException">
 357         <paramref name="mapName" /> is <see langword="null" />.</exception>
 358       <exception cref="T:System.ArgumentException">
 359         <paramref name="mapName" /> is an empty string.
 360
 361  -or-
 362
 363  <paramref name="access" /> is set to write-only with the <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> enumeration value.</exception>
 364       <exception cref="T:System.ArgumentOutOfRangeException">
 365         <paramref name="capacity" /> is greater than the size of the logical address space.
 366
 367  -or-
 368
 369  <paramref name="capacity" /> is less than or equal to zero.
 370
 371  -or-
 372
 373  <paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.
 374
 375  -or-
 376
 377  <paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> enumeration value.</exception>
 378       <exception cref="T:System.UnauthorizedAccessException">The operating system denied the specified access to the file; for example, access is set to <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write" /> or <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />, but the file or directory is read-only.</exception>
 379       <returns>A memory-mapped file that has the specified characteristics.</returns>
 380     </member>
 381     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewAccessor">
 382       <summary>Creates a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor" /> that maps to a view of the memory-mapped file.</summary>
 383       <exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
 384       <returns>A randomly accessible block of memory.</returns>
 385     </member>
 386     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewAccessor(System.Int64,System.Int64)">
 387       <summary>Creates a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor" /> that maps to a view of the memory-mapped file, and that has the specified offset and size.</summary>
 388       <param name="offset">The byte at which to start the view.</param>
 389       <param name="size">The size of the view. Specify 0 (zero) to create a view that starts at <paramref name="offset" /> and ends approximately at the end of the memory-mapped file.</param>
 390       <exception cref="T:System.ArgumentOutOfRangeException">
 391         <paramref name="offset" /> or <paramref name="size" /> is a negative value.
 392
 393  -or-
 394
 395  <paramref name="size" /> is greater than the logical address space.</exception>
 396       <exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
 397       <exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
 398       <returns>A randomly accessible block of memory.</returns>
 399     </member>
 400     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewAccessor(System.Int64,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess)">
 401       <summary>Creates a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor" /> that maps to a view of the memory-mapped file, and that has the specified offset, size, and access restrictions.</summary>
 402       <param name="offset">The byte at which to start the view.</param>
 403       <param name="size">The size of the view. Specify 0 (zero) to create a view that starts at <paramref name="offset" /> and ends approximately at the end of the memory-mapped file.</param>
 404       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />.</param>
 405       <exception cref="T:System.ArgumentOutOfRangeException">
 406         <paramref name="offset" /> or <paramref name="size" /> is a negative value.
 407
 408  -or-
 409
 410  <paramref name="size" /> is greater than the logical address space.</exception>
 411       <exception cref="T:System.UnauthorizedAccessException">
 412         <paramref name="access" /> is invalid for the memory-mapped file.</exception>
 413       <exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
 414       <returns>A randomly accessible block of memory.</returns>
 415     </member>
 416     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewStream">
 417       <summary>Creates a stream that maps to a view of the memory-mapped file.</summary>
 418       <exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
 419       <returns>A stream of memory.</returns>
 420     </member>
 421     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewStream(System.Int64,System.Int64)">
 422       <summary>Creates a stream that maps to a view of the memory-mapped file, and that has the specified offset and size.</summary>
 423       <param name="offset">The byte at which to start the view.</param>
 424       <param name="size">The size of the view. Specify 0 (zero) to create a view that starts at <paramref name="offset" /> and ends approximately at the end of the memory-mapped file.</param>
 425       <exception cref="T:System.ArgumentOutOfRangeException">
 426         <paramref name="offset" /> or <paramref name="size" /> is a negative value.
 427
 428  -or-
 429
 430  <paramref name="size" /> is greater than the logical address space.</exception>
 431       <exception cref="T:System.UnauthorizedAccessException">Access to the memory-mapped file is unauthorized.</exception>
 432       <exception cref="T:System.IO.IOException">
 433         <paramref name="size" /> is greater than the total virtual memory.</exception>
 434       <returns>A stream of memory that has the specified offset and size.</returns>
 435     </member>
 436     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewStream(System.Int64,System.Int64,System.IO.MemoryMappedFiles.MemoryMappedFileAccess)">
 437       <summary>Creates a stream that maps to a view of the memory-mapped file, and that has the specified offset, size, and access type.</summary>
 438       <param name="offset">The byte at which to start the view.</param>
 439       <param name="size">The size of the view. Specify 0 (zero) to create a view that starts at <paramref name="offset" /> and ends approximately at the end of the memory-mapped file.</param>
 440       <param name="access">One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite" />.</param>
 441       <exception cref="T:System.ArgumentOutOfRangeException">
 442         <paramref name="offset" /> or <paramref name="size" /> is a negative value.
 443
 444  -or-
 445
 446  <paramref name="size" /> is greater than the logical address space.
 447
 448  -or-
 449
 450  <paramref name="access" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess" /> enumeration value.</exception>
 451       <exception cref="T:System.UnauthorizedAccessException">
 452         <paramref name="access" /> is invalid for the memory-mapped file.</exception>
 453       <exception cref="T:System.IO.IOException">
 454         <paramref name="size" /> is greater than the total virtual memory.
 455
 456  -or-
 457
 458  <paramref name="access" /> is invalid for the memory-mapped file.</exception>
 459       <returns>A stream of memory that has the specified characteristics.</returns>
 460     </member>
 461     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.Dispose">
 462       <summary>Releases all resources used by the <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" />.</summary>
 463     </member>
 464     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.Dispose(System.Boolean)">
 465       <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile" /> and optionally releases the managed resources.</summary>
 466       <param name="disposing">
 467         <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
 468     </member>
 469     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.OpenExisting(System.String)">
 470       <summary>Opens an existing memory-mapped file that has the specified name in system memory.</summary>
 471       <param name="mapName">The name of the memory-mapped file.</param>
 472       <exception cref="T:System.ArgumentNullException">
 473         <paramref name="mapName" /> is <see langword="null" />.</exception>
 474       <exception cref="T:System.ArgumentException">
 475         <paramref name="mapName" /> is an empty string.</exception>
 476       <exception cref="T:System.IO.FileNotFoundException">The file specified for <paramref name="mapName" /> does not exist.</exception>
 477       <returns>A memory-mapped file that has the specified name.</returns>
 478     </member>
 479     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.OpenExisting(System.String,System.IO.MemoryMappedFiles.MemoryMappedFileRights)">
 480       <summary>Opens an existing memory-mapped file that has the specified name and access rights in system memory.</summary>
 481       <param name="mapName">The name of the memory-mapped file to open.</param>
 482       <param name="desiredAccessRights">One of the enumeration values that specifies the access rights to apply to the memory-mapped file.</param>
 483       <exception cref="T:System.ArgumentNullException">
 484         <paramref name="mapName" /> is <see langword="null" />.</exception>
 485       <exception cref="T:System.ArgumentException">
 486         <paramref name="mapName" /> is an empty string.</exception>
 487       <exception cref="T:System.ArgumentOutOfRangeException">
 488         <paramref name="desiredAccessRights" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileRights" /> enumeration value.</exception>
 489       <exception cref="T:System.IO.FileNotFoundException">The file specified for <paramref name="mapName" /> does not exist.</exception>
 490       <returns>A memory-mapped file that has the specified characteristics.</returns>
 491     </member>
 492     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedFile.OpenExisting(System.String,System.IO.MemoryMappedFiles.MemoryMappedFileRights,System.IO.HandleInheritability)">
 493       <summary>Opens an existing memory-mapped file that has the specified name, access rights, and inheritability in system memory.</summary>
 494       <param name="mapName">The name of the memory-mapped file to open.</param>
 495       <param name="desiredAccessRights">One of the enumeration values that specifies the access rights to apply to the memory-mapped file.</param>
 496       <param name="inheritability">One of the enumeration values that specifies whether a handle to the memory-mapped file can be inherited by a child process. The default is <see cref="F:System.IO.HandleInheritability.None" />.</param>
 497       <exception cref="T:System.ArgumentNullException">
 498         <paramref name="mapName" /> is <see langword="null" />.</exception>
 499       <exception cref="T:System.ArgumentException">
 500         <paramref name="mapName" /> is an empty string.</exception>
 501       <exception cref="T:System.ArgumentOutOfRangeException">
 502         <paramref name="desiredAccessRights" /> is not a valid <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFileRights" /> enumeration value.
 503
 504  -or-
 505
 506  <paramref name="inheritability" /> is not a valid <see cref="T:System.IO.HandleInheritability" /> enumeration value.</exception>
 507       <exception cref="T:System.UnauthorizedAccessException">The requested access is invalid for the memory-mapped file.</exception>
 508       <exception cref="T:System.IO.FileNotFoundException">The file specified for <paramref name="mapName" /> does not exist.</exception>
 509       <returns>A memory-mapped file that has the specified characteristics.</returns>
 510     </member>
 511     <member name="P:System.IO.MemoryMappedFiles.MemoryMappedFile.SafeMemoryMappedFileHandle">
 512       <summary>Gets the file handle of a memory-mapped file.</summary>
 513       <returns>The handle to the memory-mapped file.</returns>
 514     </member>
 515     <member name="T:System.IO.MemoryMappedFiles.MemoryMappedFileAccess">
 516       <summary>Specifies access capabilities and restrictions for a memory-mapped file or view.</summary>
 517     </member>
 518     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.CopyOnWrite">
 519       <summary>Read and write access to the file, with the restriction that any write operations will not be seen by other processes.</summary>
 520     </member>
 521     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Read">
 522       <summary>Read-only access to the file.</summary>
 523     </member>
 524     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadExecute">
 525       <summary>Read access to the file that can store and run executable code.</summary>
 526     </member>
 527     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWrite">
 528       <summary>Read and write access to the file.</summary>
 529     </member>
 530     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.ReadWriteExecute">
 531       <summary>Read and write access to the file that can store and run executable code.</summary>
 532     </member>
 533     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileAccess.Write">
 534       <summary>Write-only access to file.</summary>
 535     </member>
 536     <member name="T:System.IO.MemoryMappedFiles.MemoryMappedFileOptions">
 537       <summary>Provides memory allocation options for memory-mapped files.</summary>
 538     </member>
 539     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileOptions.DelayAllocatePages">
 540       <summary>Memory allocation is delayed until a view is created with either the <see cref="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewAccessor" /> or <see cref="M:System.IO.MemoryMappedFiles.MemoryMappedFile.CreateViewStream" /> method.</summary>
 541     </member>
 542     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileOptions.None">
 543       <summary>No memory allocation options are applied.</summary>
 544     </member>
 545     <member name="T:System.IO.MemoryMappedFiles.MemoryMappedFileRights">
 546       <summary>Specifies access rights to a memory-mapped file that is not associated with a file on disk.</summary>
 547     </member>
 548     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.AccessSystemSecurity">
 549       <summary>The right to get or set permissions on a file.</summary>
 550     </member>
 551     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.ChangePermissions">
 552       <summary>The right to change the security and audit rules associated with a file.</summary>
 553     </member>
 554     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.CopyOnWrite">
 555       <summary>The right to read and write to a file with the restriction that write operations will not be seen by other processes.</summary>
 556     </member>
 557     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.Delete">
 558       <summary>The right to delete a file.</summary>
 559     </member>
 560     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.Execute">
 561       <summary>The right to run an application file.</summary>
 562     </member>
 563     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.FullControl">
 564       <summary>The right to exert full control over a file, and to modify access control and audit rules. This value represents the right to do anything with a file and is the combination of all rights in this enumeration.</summary>
 565     </member>
 566     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.Read">
 567       <summary>The right to open and copy a file as read-only.</summary>
 568     </member>
 569     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.ReadExecute">
 570       <summary>The right to open and copy a folder or file as read-only, and to run application files. This right includes the <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.Read" /> right and the <see cref="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.Execute" /> right.</summary>
 571     </member>
 572     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.ReadPermissions">
 573       <summary>The right to open and copy access and audit rules from a file. This does not include the right to read data, file system attributes, or extended file system attributes.</summary>
 574     </member>
 575     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.ReadWrite">
 576       <summary>The right to open and copy a file, and the right to add data to a file or remove data from a file.</summary>
 577     </member>
 578     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.ReadWriteExecute">
 579       <summary>The right to open and copy a file, the right to add data to a file or remove data from a file, and the right to run an application file.</summary>
 580     </member>
 581     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.TakeOwnership">
 582       <summary>The right to change the owner of a file.</summary>
 583     </member>
 584     <member name="F:System.IO.MemoryMappedFiles.MemoryMappedFileRights.Write">
 585       <summary>The right to add data to a file or remove data from a file.</summary>
 586     </member>
 587     <member name="T:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor">
 588       <summary>Represents a randomly accessed view of a memory-mapped file.</summary>
 589     </member>
 590     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor.Flush">
 591       <summary>Clears all buffers for this view and causes any buffered data to be written to the underlying file.</summary>
 592       <exception cref="T:System.ObjectDisposedException">Methods were called after the accessor was closed.</exception>
 593     </member>
 594     <member name="P:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor.PointerOffset">
 595       <summary>Gets the number of bytes by which the starting position of this view is offset from the beginning of the memory-mapped file.</summary>
 596       <exception cref="T:System.InvalidOperationException">The object from which this instance was created is <see langword="null" />.</exception>
 597       <returns>The number of bytes between the starting position of this view and the beginning of the memory-mapped file.</returns>
 598     </member>
 599     <member name="P:System.IO.MemoryMappedFiles.MemoryMappedViewAccessor.SafeMemoryMappedViewHandle">
 600       <summary>Gets a handle to the view of a memory-mapped file.</summary>
 601       <returns>A wrapper for the operating system's handle to the view of the file.</returns>
 602     </member>
 603     <member name="T:System.IO.MemoryMappedFiles.MemoryMappedViewStream">
 604       <summary>Represents a view of a memory-mapped file as a sequentially accessed stream.</summary>
 605     </member>
 606     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedViewStream.Flush">
 607       <summary>Clears all buffers for this stream and causes any buffered data to be written to the underlying file.</summary>
 608     </member>
 609     <member name="M:System.IO.MemoryMappedFiles.MemoryMappedViewStream.SetLength(System.Int64)">
 610       <summary>Sets the length of the current stream.</summary>
 611       <param name="value">The desired length of the current stream in bytes.</param>
 612       <exception cref="T:System.NotSupportedException">This method is not supported.</exception>
 613     </member>
 614     <member name="P:System.IO.MemoryMappedFiles.MemoryMappedViewStream.PointerOffset">
 615       <summary>Gets the number of bytes by which the starting position of this view is offset from the beginning of the memory-mapped file.</summary>
 616       <exception cref="T:System.InvalidOperationException">The object from which this instance was created is <see langword="null" />.</exception>
 617       <returns>The number of bytes between the starting position of this view and the beginning of the memory-mapped file.</returns>
 618     </member>
 619     <member name="P:System.IO.MemoryMappedFiles.MemoryMappedViewStream.SafeMemoryMappedViewHandle">
 620       <summary>Gets a handle to the view of a memory-mapped file.</summary>
 621       <returns>A wrapper for the operating system's handle to the view of the file.</returns>
 622     </member>
 623   </members>
 624 </doc>