Windows apps
Collapse the table of content
Expand the table of content
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.

FileStream.SetLength Method (Int64)

 

Sets the length of this stream to the given value.

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

public override void SetLength(
	long value
)

Parameters

value
Type: System.Int64

The new length of the stream.

Exception Condition
IOException

An I/O error has occurred.

NotSupportedException

The stream does not support both writing and seeking.

ArgumentOutOfRangeException

Attempted to set the value parameter to less than 0.

This method overrides SetLength.

If the given value is less than the current length of the stream, the stream is truncated. In this scenario, if the current position is greater than the new length, the current position is moved to the last byte of the stream. If the given value is larger than the current length of the stream, the stream is expanded, and the current position remains the same. If the stream is expanded, the contents of the stream between the old and the new length are undefined.

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

System_CAPS_noteNote

Use the CanWrite property to determine whether the current instance supports writing, and the CanSeek property to determine whether seeking is supported. For additional information, see CanWrite and CanSeek.

For a list of common file and directory operations, see Common I/O Tasks.

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2016 Microsoft