SafeMemoryMappedViewHandle Class

Reference

Definition

Namespace:: Microsoft.Win32.SafeHandles

Assembly:: System.IO.MemoryMappedFiles.dll

Assembly:: System.Core.dll

Assembly:: netstandard.dll

Source:: SafeMemoryMappedViewHandle.cs

Source:: SafeMemoryMappedViewHandle.cs

Source:: SafeMemoryMappedViewHandle.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 view of a block of unmanaged memory for random access.

public ref class SafeMemoryMappedViewHandle sealed : System::Runtime::InteropServices::SafeBuffer

public sealed class SafeMemoryMappedViewHandle : System.Runtime.InteropServices.SafeBuffer

[System.Security.SecurityCritical(System.Security.SecurityCriticalScope.Everything)]
public sealed class SafeMemoryMappedViewHandle : System.Runtime.InteropServices.SafeBuffer

type SafeMemoryMappedViewHandle = class
    inherit SafeBuffer

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

Public NotInheritable Class SafeMemoryMappedViewHandle
Inherits SafeBuffer

Inheritance: Object

SafeHandle

SafeBuffer
SafeMemoryMappedViewHandle

Inheritance: Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid

SafeBuffer
SafeMemoryMappedViewHandle

Attributes: SecurityCriticalAttribute

Remarks

Use the MemoryMappedViewAccessor.SafeMemoryMappedViewHandle 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

SafeMemoryMappedViewHandle()

Initializes a SafeMemoryMappedViewHandle instance.

Fields

handle

Specifies the handle to be wrapped.

(Inherited from SafeHandle)

Properties

ByteLength	Gets the size of the buffer, in bytes. (Inherited from SafeBuffer)
IsClosed	Gets a value indicating whether the handle is closed. (Inherited from SafeHandle)
IsInvalid	Gets a value that indicates whether the handle is invalid. (Inherited from SafeBuffer)

Methods

AcquirePointer(Byte*)	Obtains a pointer from a SafeBuffer object for a block of memory. (Inherited from SafeBuffer)
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)
Initialize(UInt32, UInt32)	Specifies the allocation size of the memory buffer by using the specified number of elements and element size. You must call this method before you use the SafeBuffer instance. (Inherited from SafeBuffer)
Initialize(UInt64)	Defines the allocation size of the memory region in bytes. You must call this method before you use the SafeBuffer instance. (Inherited from SafeBuffer)
Initialize<T>(UInt32)	Defines the allocation size of the memory region by specifying the number of value types. You must call this method before you use the SafeBuffer instance. (Inherited from SafeBuffer)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Read<T>(UInt64)	Reads a value type from memory at the specified offset. (Inherited from SafeBuffer)
ReadArray<T>(UInt64, T[], Int32, Int32)	Reads the specified number of value types from memory starting at the offset, and writes them into an array starting at the index. (Inherited from SafeBuffer)
ReadSpan<T>(UInt64, Span<T>)	Reads value types from memory starting at the offset, and writes them into a span. The number of value types that will be read is determined by the length of the span. (Inherited from SafeBuffer)
ReleaseHandle()	When overridden in a derived class, executes the code required to free the handle. (Inherited from SafeHandle)
ReleasePointer()	Releases a pointer that was obtained by the AcquirePointer(Byte*) method. (Inherited from SafeBuffer)
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)
Write<T>(UInt64, T)	Writes a value type to memory at the given location. (Inherited from SafeBuffer)
WriteArray<T>(UInt64, T[], Int32, Int32)	Writes the specified number of value types to a memory location by reading bytes starting from the specified location in the input array. (Inherited from SafeBuffer)
WriteSpan<T>(UInt64, ReadOnlySpan<T>)	Writes the value types from a read-only span to a memory location. (Inherited from SafeBuffer)

Applies to

Share via