Export (0) Print
Expand All

MemoryMappedFile.OpenExisting Method (String, MemoryMappedFileRights, HandleInheritability)

Opens an existing memory-mapped file that has the specified name, access rights, and inheritability in system memory.

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

[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static MemoryMappedFile OpenExisting(
	string mapName,
	MemoryMappedFileRights desiredAccessRights,
	HandleInheritability inheritability
)

Parameters

mapName
Type: System.String
The name of the memory-mapped file to open.
desiredAccessRights
Type: System.IO.MemoryMappedFiles.MemoryMappedFileRights
One of the enumeration values that specifies the access rights to apply to the memory-mapped file.
inheritability
Type: System.IO.HandleInheritability
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 None.

Return Value

Type: System.IO.MemoryMappedFiles.MemoryMappedFile
A memory-mapped file that has the specified characteristics.

ExceptionCondition
ArgumentException

mapName is an empty string.

ArgumentNullException

mapName is null.

ArgumentOutOfRangeException

desiredAccessRights is not a valid MemoryMappedFileRights enumeration value.

-or-

inheritability is not a valid HandleInheritability enumeration value.

UnauthorizedAccessException

The requested access is invalid for the memory-mapped file.

FileNotFoundException

The file specified for mapName does not exist.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft