UnmanagedMemoryStream Class

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides access to unmanaged blocks of memory from managed code.

Inheritance Hierarchy

System..::.Object
System.IO..::.Stream
System.IO..::.UnmanagedMemoryStream

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

Syntax

Public Class UnmanagedMemoryStream _
    Inherits Stream
public class UnmanagedMemoryStream : Stream

The UnmanagedMemoryStream type exposes the following members.

Properties

Name Description
CanRead Infrastructure. Gets a value indicating whether a stream supports reading. (Overrides Stream..::.CanRead.)
CanSeek Infrastructure. Gets a value indicating whether a stream supports seeking. (Overrides Stream..::.CanSeek.)
CanTimeout Gets a value that determines whether the current stream can time out. (Inherited from Stream.)
CanWrite Infrastructure. Gets a value indicating whether a stream supports writing. (Overrides Stream..::.CanWrite.)
Capacity Infrastructure. Gets the stream length (size) or the total amount of memory assigned to a stream (capacity).
Length Infrastructure. Gets the length of the data in a stream. (Overrides Stream..::.Length.)
Position Infrastructure. Gets or sets the current position in a stream. (Overrides Stream..::.Position.)
PositionPointer Infrastructure. Gets or sets a byte pointer to a stream based on the current position in the stream.
ReadTimeout Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
WriteTimeout Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)

Top

Methods

Name Description
BeginRead Begins an asynchronous read operation. (Inherited from Stream.)
BeginWrite Begins an asynchronous write operation. (Inherited from Stream.)
Close Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.)
CopyTo(Stream) Reads all the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.)
CopyTo(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.)
CopyToAsync(Stream) Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
CopyToAsync(Stream, Int32) Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
CopyToAsync(Stream, Int32, CancellationToken) Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Inherited from Stream.)
Dispose()()() Releases all resources used by the Stream. (Inherited from Stream.)
Dispose(Boolean) Infrastructure. Releases the unmanaged resources used by the UnmanagedMemoryStream and optionally releases the managed resources. (Overrides Stream..::.Dispose(Boolean).)
EndRead Waits for the pending asynchronous read to complete. (Inherited from Stream.)
EndWrite Ends an asynchronous write operation. (Inherited from Stream.)
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Flush Infrastructure. Overrides the Flush method so that no action is performed. (Overrides Stream..::.Flush()()().)
FlushAsync()()() Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)
FlushAsync(CancellationToken) Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. (Inherited from Stream.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Read Infrastructure. Reads the specified number of bytes into the specified array. (Overrides Stream..::.Read(array<Byte>[]()[], Int32, Int32).)
ReadAsync(array<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.)
ReadAsync(array<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. (Inherited from Stream.)
ReadByte Infrastructure. Reads 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. (Overrides Stream..::.ReadByte()()().)
Seek Infrastructure. Sets the current position of the current stream to the given value. (Overrides Stream..::.Seek(Int64, SeekOrigin).)
SetLength Infrastructure. Sets the length of a stream to a specified value. (Overrides Stream..::.SetLength(Int64).)
ToString Returns a string that represents the current object. (Inherited from Object.)
Write Infrastructure. Writes a block of bytes to the current stream using data from a buffer. (Overrides Stream..::.Write(array<Byte>[]()[], Int32, Int32).)
WriteAsync(array<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.)
WriteAsync(array<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. (Inherited from Stream.)
WriteByte Infrastructure. Writes a byte to the current position in the file stream. (Overrides Stream..::.WriteByte(Byte).)

Top

Extension Methods

Name Description
AsInputStream (Defined by WindowsRuntimeStreamExtensions.)
AsOutputStream (Defined by WindowsRuntimeStreamExtensions.)

Top

Remarks

This class supports access to unmanaged memory using the existing stream-based model and does not require that the contents in the unmanaged memory be copied to the heap.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

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

See Also

Reference

System.IO Namespace