Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MemoryMappedViewStream Class

Represents a view of a memory-mapped file as a sequentially accessed stream.

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.IO.UnmanagedMemoryStream
        System.IO.MemoryMappedFiles.MemoryMappedViewStream

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

public sealed class MemoryMappedViewStream : UnmanagedMemoryStream

The MemoryMappedViewStream type exposes the following members.

  NameDescription
Public propertyCanReadGets a value indicating whether a stream supports reading. (Inherited from UnmanagedMemoryStream.)
Public propertyCanSeekGets a value indicating whether a stream supports seeking. (Inherited from UnmanagedMemoryStream.)
Public propertyCanTimeoutGets a value that determines whether the current stream can time out. (Inherited from Stream.)
Public propertyCanWriteGets a value indicating whether a stream supports writing. (Inherited from UnmanagedMemoryStream.)
Public propertyCapacityGets the stream length (size) or the total amount of memory assigned to a stream (capacity). (Inherited from UnmanagedMemoryStream.)
Public propertyLengthGets the length of the data in a stream. (Inherited from UnmanagedMemoryStream.)
Public propertyPositionGets or sets the current position in a stream. (Inherited from UnmanagedMemoryStream.)
Public propertyPositionPointerGets or sets a byte pointer to a stream based on the current position in the stream. (Inherited from UnmanagedMemoryStream.)
Public propertyReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
Public propertySafeMemoryMappedViewHandleGets a handle to the view of a memory-mapped file.
Public propertyWriteTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)
Top

  NameDescription
Public methodBeginReadBegins an asynchronous read operation. (Inherited from Stream.)
Public methodBeginWriteBegins an asynchronous write operation. (Inherited from Stream.)
Public methodCloseCloses the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.)
Public methodCopyTo(Stream)Reads the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.)
Public methodCopyTo(Stream, Int32)Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (Inherited from Stream.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Protected methodCreateWaitHandle Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
Public methodDispose()Releases all resources used by the Stream. (Inherited from Stream.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the UnmanagedMemoryStream and optionally releases the managed resources. (Inherited from UnmanagedMemoryStream.)
Public methodEndReadWaits for the pending asynchronous read to complete. (Inherited from Stream.)
Public methodEndWriteEnds an asynchronous write operation. (Inherited from Stream.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFlushClears all buffers for this stream and causes any buffered data to be written to the underlying file. (Overrides UnmanagedMemoryStream.Flush().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitialize(Byte*, Int64, Int64, FileAccess)Initializes a new instance of the UnmanagedMemoryStream class by using a pointer to an unmanaged memory location. (Inherited from UnmanagedMemoryStream.)
Protected methodInitialize(SafeBuffer, Int64, Int64, FileAccess)Initializes a new instance of the UnmanagedMemoryStream class in a safe buffer with a specified offset, length, and file access. (Inherited from UnmanagedMemoryStream.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodObjectInvariantInfrastructure. Provides support for a Contract. (Inherited from Stream.)
Public methodReadReads the specified number of bytes into the specified array. (Inherited from UnmanagedMemoryStream.)
Public methodReadByteReads a byte from a stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from UnmanagedMemoryStream.)
Public methodSeekSets the current position of the current stream to the given value. (Inherited from UnmanagedMemoryStream.)
Public methodSetLengthInfrastructure. Sets the length of the current stream. (Overrides UnmanagedMemoryStream.SetLength(Int64).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteWrites a block of bytes to the current stream using data from a buffer. (Inherited from UnmanagedMemoryStream.)
Public methodWriteByteWrites a byte to the current position in the file stream. (Inherited from UnmanagedMemoryStream.)
Top

Use the CreateViewStream method of a MemoryMappedFile object to get this stream.

The following example obtains a MemoryMappedViewStream of a memory-mapped file and writes a value to the stream for inter-process communication.

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


using (MemoryMappedViewStream stream = mmf.CreateViewStream())
{
    BinaryWriter writer = new BinaryWriter(stream);
    writer.Write(1);
}


.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Community Additions

Show:
© 2014 Microsoft