MemoryMappedFile.CreateFromFile Method (String, FileMode)

.NET Framework (current version)

Creates a memory-mapped file that has the specified access mode from a file on disk.

Namespace:   System.IO.MemoryMappedFiles
Assembly:  System.Core (in System.Core.dll)

Public Shared Function CreateFromFile (
	path As String,
	mode As FileMode
) As MemoryMappedFile


Type: System.String

The path to file to map.

Type: System.IO.FileMode

Access mode; must be Open.

Return Value

Type: System.IO.MemoryMappedFiles.MemoryMappedFile

A memory-mapped file that has the specified access mode.

Exception Condition

path is an empty string, contains only white space, or has one or more invalid characters, as defined by the Path.GetInvalidFileNameChars method.


path refers to an invalid device.


mode is Append.


path is null.


mode is Create, CreateNew, or Truncate.


mode is OpenOrCreate and the file on disk does not exist.


An I/O error occurred.


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.


The caller does not have the required permissions for the file.

The mode parameter pertains to the source file on disk. You can use only the Open enumeration value to create the memory-mapped file from the source file on disk.

.NET Framework
Available since 4.0
Return to top