SafeMemoryMappedFileHandle Class

Reference

Definition

Namespace:: Microsoft.Win32.SafeHandles

Assembly:: System.IO.MemoryMappedFiles.dll

Assembly:: System.Core.dll

Assembly:: netstandard.dll

Source:: SafeMemoryMappedFileHandle.cs

Source:: SafeMemoryMappedFileHandle.cs

Source:: SafeMemoryMappedFileHandle.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a safe handle that represents a memory-mapped file for sequential access.

public ref class SafeMemoryMappedFileHandle sealed : Microsoft::Win32::SafeHandles::SafeHandleZeroOrMinusOneIsInvalid

public ref class SafeMemoryMappedFileHandle sealed : System::Runtime::InteropServices::SafeHandle

public sealed class SafeMemoryMappedFileHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

public sealed class SafeMemoryMappedFileHandle : System.Runtime.InteropServices.SafeHandle

[System.Security.SecurityCritical(System.Security.SecurityCriticalScope.Everything)]
public sealed class SafeMemoryMappedFileHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

type SafeMemoryMappedFileHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid

type SafeMemoryMappedFileHandle = class
    inherit SafeHandle

[<System.Security.SecurityCritical(System.Security.SecurityCriticalScope.Everything)>]
type SafeMemoryMappedFileHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid

Public NotInheritable Class SafeMemoryMappedFileHandle
Inherits SafeHandleZeroOrMinusOneIsInvalid

Public NotInheritable Class SafeMemoryMappedFileHandle
Inherits SafeHandle

Inheritance: Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid
SafeMemoryMappedFileHandle

Inheritance: Object

SafeHandle
SafeMemoryMappedFileHandle

Attributes: SecurityCriticalAttribute

Remarks

Use the MemoryMappedFile.SafeMemoryMappedFileHandle property to obtain the safe handle.

Important

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Constructors

SafeMemoryMappedFileHandle()

Creates a SafeMemoryMappedFileHandle.

Fields

handle

Specifies the handle to be wrapped.

(Inherited from SafeHandle)

Properties

IsClosed	Gets a value indicating whether the handle is closed. (Inherited from SafeHandle)
IsInvalid	Gets a value that indicates whether the handle is invalid.
IsInvalid	Gets a value that indicates whether the handle is invalid. (Inherited from SafeHandleZeroOrMinusOneIsInvalid)

Methods

Close()	Marks the handle for releasing and freeing resources. (Inherited from SafeHandle)
DangerousAddRef(Boolean)	Manually increments the reference counter on SafeHandle instances. (Inherited from SafeHandle)
DangerousGetHandle()	Returns the value of the handle field. (Inherited from SafeHandle)
DangerousRelease()	Manually decrements the reference counter on a SafeHandle instance. (Inherited from SafeHandle)
Dispose()	Releases all resources used by the SafeHandle class. (Inherited from SafeHandle)
Dispose(Boolean)	Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation. (Inherited from SafeHandle)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ReleaseHandle()	When overridden in a derived class, executes the code required to free the handle. (Inherited from SafeHandle)
SetHandle(IntPtr)	Sets the handle to the specified pre-existing handle. (Inherited from SafeHandle)
SetHandleAsInvalid()	Marks a handle as no longer used. (Inherited from SafeHandle)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via