MemoryMappedViewAccessor Class

MemoryMappedViewAccessor Class

.NET Framework (current version)
 

Represents a randomly accessed view of a memory-mapped file.

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

System.Object
  System.IO.UnmanagedMemoryAccessor
    System.IO.MemoryMappedFiles.MemoryMappedViewAccessor

public sealed class MemoryMappedViewAccessor : UnmanagedMemoryAccessor

NameDescription
System_CAPS_pubpropertyCanRead

Determines whether the accessor is readable.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubpropertyCanWrite

Determines whether the accessory is writable.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubpropertyCapacity

Gets the capacity of the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubpropertyPointerOffset

[Supported in the .NET Framework 4.5.1 and later versions]

Gets the number of bytes by which the starting position of this view is offset from the beginning of the memory-mapped file.

System_CAPS_pubpropertySafeMemoryMappedViewHandle

Gets a handle to the view of a memory-mapped file.

NameDescription
System_CAPS_pubmethodDispose()

Releases all resources used by the UnmanagedMemoryAccessor. (Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodFlush()

Clears all buffers for this view and causes any buffered data to be written to the underlying file.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodRead<T>(Int64, T)

Reads a structure of type T from the accessor into a provided reference.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadArray<T>(Int64, T[], Int32, Int32)

Reads structures of type T from the accessor into an array of type T.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadBoolean(Int64)

Reads a Boolean value from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadByte(Int64)

Reads a byte value from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadChar(Int64)

Reads a character from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadDecimal(Int64)

Reads a decimal value from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadDouble(Int64)

Reads a double-precision floating-point value from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadInt16(Int64)

Reads a 16-bit integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadInt32(Int64)

Reads a 32-bit integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadInt64(Int64)

Reads a 64-bit integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadSByte(Int64)

Reads an 8-bit signed integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadSingle(Int64)

Reads a single-precision floating-point value from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadUInt16(Int64)

Reads an unsigned 16-bit integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadUInt32(Int64)

Reads an unsigned 32-bit integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodReadUInt64(Int64)

Reads an unsigned 64-bit integer from the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Int64, Boolean)

Writes a Boolean value into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Byte)

Writes a byte value into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Char)

Writes a character into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Decimal)

Writes a decimal value into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Double)

Writes a Double value into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Int16)

Writes a 16-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Int32)

Writes a 32-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Int64)

Writes a 64-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, SByte)

Writes an 8-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, Single)

Writes a Single into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, UInt16)

Writes an unsigned 16-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, UInt32)

Writes an unsigned 32-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite(Int64, UInt64)

Writes an unsigned 64-bit integer into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWrite<T>(Int64, T)

Writes a structure into the accessor.(Inherited from UnmanagedMemoryAccessor.)

System_CAPS_pubmethodWriteArray<T>(Int64, T[], Int32, Int32)

Writes structures from an array of type T into the accessor.(Inherited from UnmanagedMemoryAccessor.)

Use the CreateViewAccessor method of a MemoryMappedFile object to get this view.

The following example obtains a MemoryMappedViewAccessor from a large memory-mapped file for editing.

This code example is part of a larger example provided for the MemoryMappedFile class.

// Create a random access view, from the 256th megabyte (the offset)
// to the 768th megabyte (the offset plus length).
using (var accessor = mmf.CreateViewAccessor(offset, length))
{
    int colorSize = Marshal.SizeOf(typeof(MyColor));
    MyColor color;

    // Make changes to the view.
    for (long i = 0; i < length; i += colorSize)
    {
        accessor.Read(i, out color);
        color.Brighten(10);
        accessor.Write(i, ref color);
    }
}

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft