MemoryMappedFile.OpenExisting Method (String, MemoryMappedFileRights, HandleInheritability)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

[SecurityCriticalAttribute]
[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.

Exception Condition
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.

SecurityPermission

for access to unmanaged code. Associated enumeration: SecurityPermissionFlag.UnmanagedCode.

.NET Framework
Available since 4.0
Return to top
Show: