MemoryMappedFile.CreateNew Method (String, Int64, MemoryMappedFileAccess)

.NET Framework (current version)
 

Creates a memory-mapped file that has the specified capacity and access type in system memory.

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

public static MemoryMappedFile CreateNew(
	string mapName,
	long capacity,
	MemoryMappedFileAccess access
)

Parameters

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.

access
Type: System.IO.MemoryMappedFiles.MemoryMappedFileAccess

One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is ReadWrite.

Return Value

Type: System.IO.MemoryMappedFiles.MemoryMappedFile

A memory-mapped file that has the specified characteristics.

Exception Condition
ArgumentException

mapName is an empty string.

-or-

access is set to write-only with the Write enumeration value.

ArgumentNullException

mapName is null.

ArgumentOutOfRangeException

capacity is less than or equal to zero.

-or-

access is not a valid MemoryMappedFileAccess enumeration value.

Use this method to create a memory-mapped file that is not persisted (that is, not associated with a file on disk), which you can use to share data between processes.

.NET Framework
Available since 4.0
Return to top
Show: