Export (0) Print
Expand All
2 out of 3 rated this helpful - Rate this topic

MemoryStream Class

Creates a stream whose backing store is memory.

To browse the .NET Framework source code for this type, see the Reference Source.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)
[<SerializableAttribute>]
[<ComVisibleAttribute(true)>]
type MemoryStream =  
    class 
        inherit Stream 
    end

The MemoryStream type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemoryStream()Initializes a new instance of the MemoryStream class with an expandable capacity initialized to zero.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemoryStream(Byte[])Initializes a new non-resizable instance of the MemoryStream class based on the specified byte array.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemoryStream(Int32)Initializes a new instance of the MemoryStream class with an expandable capacity initialized as specified.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemoryStream(Byte[], Boolean)Initializes a new non-resizable instance of the MemoryStream class based on the specified byte array with the CanWrite property set as specified.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemoryStream(Byte[], Int32, Int32)Initializes a new non-resizable instance of the MemoryStream class based on the specified region (index) of a byte array.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemoryStream(Byte[], Int32, Int32, Boolean)Initializes a new non-resizable instance of the MemoryStream class based on the specified region of a byte array, with the CanWrite property set as specified.
Public methodSupported by the XNA FrameworkMemoryStream(Byte[], Int32, Int32, Boolean, Boolean)Initializes a new instance of the MemoryStream class based on the specified region of a byte array, with the CanWrite property set as specified, and the ability to call GetBuffer set as specified.
Top
  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCanReadGets a value indicating whether the current stream supports reading. (Overrides Stream.CanRead.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCanSeekGets a value indicating whether the current stream supports seeking. (Overrides Stream.CanSeek.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCanTimeoutGets a value that determines whether the current stream can time out. (Inherited from Stream.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCanWriteGets a value indicating whether the current stream supports writing. (Overrides Stream.CanWrite.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCapacityGets or sets the number of bytes allocated for this stream.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsLengthGets the length of the stream in bytes. (Overrides Stream.Length.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsPositionGets or sets the current position within the stream. (Overrides Stream.Position.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteTimeoutGets 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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryBeginReadBegins an asynchronous read operation. (Consider using ReadAsync instead; see the Remarks section.) (Inherited from Stream.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryBeginWriteBegins an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.) (Inherited from Stream.)
Public methodSupported by the XNA FrameworkCloseCloses the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCopyTo(Stream)Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodSupported in .NET for Windows Store appsCopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodSupported in .NET for Windows Store appsCopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32, CancellationToken)Asynchronously reads all the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Overrides Stream.CopyToAsync(Stream, Int32, CancellationToken).)
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 methodSupported by the XNA FrameworkCreateWaitHandle Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose()Releases all resources used by the Stream. (Inherited from Stream.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose(Boolean)Releases the unmanaged resources used by the MemoryStream class and optionally releases the managed resources. (Overrides Stream.Dispose(Boolean).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEndReadWaits for the pending asynchronous read to complete. (Consider using ReadAsync instead; see the Remarks section.) (Inherited from Stream.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEndWriteEnds an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.) (Inherited from Stream.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFlushOverrides the Stream.Flush method so that no action is performed. (Overrides Stream.Flush().)
Public methodSupported in .NET for Windows Store appsFlushAsync()Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)
Public methodSupported in .NET for Windows Store appsFlushAsync(CancellationToken)Asynchronously clears all buffers for this stream, and monitors cancellation requests. (Overrides Stream.FlushAsync(CancellationToken).)
Public methodSupported by the XNA FrameworkGetBufferReturns the array of unsigned bytes from which this stream was created.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseClone()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. Obsolete. Provides support for a Contract. (Inherited from Stream.)

In .NET Framework Client Profile, this member is overridden by ObjectInvariant().
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsReadReads a block of bytes from the current stream and writes the data to a buffer. (Overrides Stream.Read(Byte[], Int32, Int32).)
Public methodSupported in .NET for Windows Store appsReadAsync(Byte[], Int32, Int32)Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream.)
Public methodSupported in .NET for Windows Store appsReadAsync(Byte[], Int32, Int32, CancellationToken)Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Overrides Stream.ReadAsync(Byte[], Int32, Int32, CancellationToken).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsReadByteReads a byte from the current stream. (Overrides Stream.ReadByte().)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsSeekSets the position within the current stream to the specified value. (Overrides Stream.Seek(Int64, SeekOrigin).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsSetLengthSets the length of the current stream to the specified value. (Overrides Stream.SetLength(Int64).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsToArrayWrites the stream contents to a byte array, regardless of the Position property.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteWrites a block of bytes to the current stream using data read from a buffer. (Overrides Stream.Write(Byte[], Int32, Int32).)
Public methodSupported in .NET for Windows Store appsWriteAsync(Byte[], Int32, Int32)Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream.)
Public methodSupported in .NET for Windows Store appsWriteAsync(Byte[], Int32, Int32, CancellationToken)Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Overrides Stream.WriteAsync(Byte[], Int32, Int32, CancellationToken).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteByteWrites a byte to the current stream at the current position. (Overrides Stream.WriteByte(Byte).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteToWrites the entire contents of this memory stream to another stream.
Top
  NameDescription
Public Extension MethodSupported in .NET for Windows Store appsAsInputStreamConverts a managed stream in the .NET for Windows Store apps to an input stream in the Windows Runtime. (Defined by WindowsRuntimeStreamExtensions.)
Public Extension MethodSupported in .NET for Windows Store appsAsOutputStreamConverts a managed stream in the .NET for Windows Store apps to an output stream in the Windows Runtime. (Defined by WindowsRuntimeStreamExtensions.)
Public Extension MethodSupported in .NET for Windows Store appsGetWindowsRuntimeBuffer()Overloaded. Returns a Windows.Storage.Streams.IBuffer interface that represents the same memory as the specified memory stream. (Defined by WindowsRuntimeBufferExtensions.)
Public Extension MethodSupported in .NET for Windows Store appsGetWindowsRuntimeBuffer(Int32, Int32)Overloaded. Returns a Windows.Storage.Streams.IBuffer interface that represents a region within the memory that the specified memory stream represents. (Defined by WindowsRuntimeBufferExtensions.)
Top
NoteNote

To view the .NET Framework source code for this type, see the Reference Source. You can browse through the source code online, download the reference for offline viewing, and step through the sources (including patches and updates) during debugging; see instructions.

The current position of a stream is the position at which the next read or write operation could take place. The current position can be retrieved or set through the Seek method. When a new instance of MemoryStream is created, the current position is set to zero.

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.

Memory streams created with an unsigned byte array provide a non-resizable stream of the data. When using a byte array, you can neither append to nor shrink the stream, although you might be able to modify the existing contents depending on the parameters passed into the constructor. Empty memory streams are resizable, and can be written to and read from.

If a MemoryStream object is added to a ResX file or a .resources file, call the GetStream method at runtime to retrieve it.

If a MemoryStream object is serialized to a resource file it will actually be serialized as an UnmanagedMemoryStream. This behavior provides better performance, as well as the ability to get a pointer to the data directly, without having to go through Stream methods.

The following code example shows how to read and write data using memory as a backing store.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.