Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CreateFromFile Method (String, FileMode)

MemoryMappedFile.CreateFromFile Method (String, FileMode)

.NET Framework 4.6 and 4.5

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)

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

Parameters

path
Type: System.String

The path to file to map.

mode
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.

ExceptionCondition
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-

mode is Append.

ArgumentNullException

path is Nothing.

IOException

mode is Create, CreateNew, or Truncate.

-or-

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

-or-

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. You can use only the Open enumeration value to create the memory-mapped file from the source file on disk.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4
Show:
© 2015 Microsoft