Export (0) Print
Expand All

SafeMemoryMappedViewHandle Class

Provides a safe handle that represents a view of a block of unmanaged memory for random access.

Namespace:  Microsoft.Win32.SafeHandles
Assembly:  System.Core (in System.Core.dll)

public sealed class SafeMemoryMappedViewHandle : SafeBuffer

The SafeMemoryMappedViewHandle type exposes the following members.

  NameDescription
Public propertyByteLengthGets the size of the buffer, in bytes. (Inherited from SafeBuffer.)
Public propertyIsClosedGets a value indicating whether the handle is closed. (Inherited from SafeHandle.)
Public propertyIsInvalidGets a value that indicates whether the handle is invalid. (Inherited from SafeHandleZeroOrMinusOneIsInvalid.)
Top

  NameDescription
Public methodAcquirePointerObtains a pointer from a SafeBuffer object for a block of memory. (Inherited from SafeBuffer.)
Public methodCloseMarks the handle for releasing and freeing resources. (Inherited from SafeHandle.)
Public methodDangerousAddRefManually increments the reference counter on SafeHandle instances. (Inherited from SafeHandle.)
Public methodDangerousGetHandleReturns the value of the handle field. (Inherited from SafeHandle.)
Public methodDangerousReleaseManually decrements the reference counter on a SafeHandle instance. (Inherited from SafeHandle.)
Public methodDispose()Releases all resources used by the SafeHandle class. (Inherited from SafeHandle.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitialize(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.)
Public methodInitialize(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.)
Public methodInitialize<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.)
Public methodRead<T>Reads a value type from memory at the specified offset. (Inherited from SafeBuffer.)
Public methodReadArray<T>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.)
Public methodReleasePointerReleases a pointer that was obtained by the AcquirePointer method. (Inherited from SafeBuffer.)
Public methodSetHandleAsInvalidMarks a handle as no longer used. (Inherited from SafeHandle.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWrite<T>Writes a value type to memory at the given location. (Inherited from SafeBuffer.)
Public methodWriteArray<T>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.)
Top

Use the MemoryMappedViewAccessor.SafeMemoryMappedViewHandle property to obtain the safe handle.

Important noteImportant

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.

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft