• Article

UnmanagedMemoryStream.SetLength Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Sets the length of a stream to a specified value.

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

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Overrides Sub SetLength ( _
    value As Long _
)

[SecuritySafeCriticalAttribute]
public override void SetLength(
    long value
)

Parameters

Exceptions

Exception Condition
IOException

An I/O error has occurred.
ObjectDisposedException

The stream is closed.
NotSupportedException

The underlying memory does not support writing.

- or -

An attempt is made to write to the stream and the CanWrite property is false.
ArgumentOutOfRangeException

The specified value exceeds the capacity of the stream.

- or -

The specified value is negative.

Remarks

If the given value is less than the current length of the stream, the stream is truncated. If the given value is larger than the current length of the stream, the stream is expanded. If the stream is expanded, the contents of the stream between the old and the new lengths are undefined.

A stream must support both writing and seeking for SetLength to work.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.