MemoryMappedFile.CreateFromFile Method (String, FileMode, String, Int64)
Creates a memory-mapped file that has the specified access mode, name, and capacity from a file on disk.
Namespace: System.IO.MemoryMappedFiles
Assembly: System.Core (in System.Core.dll)
public static MemoryMappedFile CreateFromFile( string path, FileMode mode, string mapName, long capacity )
Parameters
- path
- Type: System.String
The path to the file to map.
- mode
- Type: System.IO.FileMode
Access mode; can be any of the FileMode enumeration values except Append.
- mapName
- Type: System.String
A name to assign to the memory-mapped file.
- capacity
- Type: System.Int64
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.
Return Value
Type: System.IO.MemoryMappedFiles.MemoryMappedFileA memory-mapped file that has the specified characteristics.
| Exception | Condition |
|---|---|
| ArgumentException | path is an empty string, contains only white space, or has one or more invalid characters, as defined by the Path.GetInvalidFileNameChars method. -or- path refers to an invalid device. -or- mapName is an empty string. -or- mode is Append. |
| ArgumentNullException | path or mapName is null. |
| ArgumentOutOfRangeException | capacity is greater than the size of the logical address space. -or- capacity is less than zero. -or- capacity is less than the file size (but not zero). -or- capacity is zero, and the size of the file on disk is also zero. |
| IOException | An I/O error occurred. |
| PathTooLongException | path exceeds the maximum length defined by the operating system. In Windows, paths must contain fewer than 248 characters, and file names must contain fewer than 260 characters. |
| SecurityException | The caller does not have the required permissions for the file. |
The mode parameter pertains to the source file on disk.
If capacity is larger than the size of the file on disk, the file on disk is increased to match the specified capacity even if no data is written to the memory-mapped file. To prevent this from occurring, specify 0 (zero) for the default capacity, which will internally set capacity to the size of the file on disk.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
