Xceed .NET Libraries Documentation
Xceed.Compression.Formats Assembly / Xceed.Compression.Formats Namespace / FormattedCompressedStream Class / SetLength Method
The desired length of the current stream in bytes.


In This Topic
    SetLength Method (FormattedCompressedStream)
    In This Topic
    Sets the length of the current stream.
    Syntax
    'Declaration
     
    
    Public Overrides Sub SetLength( _
       ByVal value As Long _
    ) 
    'Usage
     
    
    Dim instance As FormattedCompressedStream
    Dim value As Long
     
    instance.SetLength(value)
    public override void SetLength( 
       long value
    )

    Parameters

    value
    The desired length of the current stream in bytes.
    Exceptions
    ExceptionDescription
    An I/O error occurs.
    The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
    Methods were called after the stream was closed.
    Remarks

    If the specified value is less than the current length of the stream, the stream is truncated. If the specified 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 length are not defined.

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

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

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    FormattedCompressedStream Class
    FormattedCompressedStream Members
    Base Implementation in SetLength