Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Compression Assembly / Xceed.Compression Namespace / CompressedStream Class / Flush Method


In This Topic
    Flush Method (CompressedStream)
    In This Topic
    Causes all pending compressed data to be written to the inner stream, and updates the underlying data source or repository of the inner stream with the current state of the buffer.
    Syntax
    'Declaration
 

    Public Overrides Sub Flush() 
    'Usage
 

    Dim instance As CompressedStream
 
instance.Flush()
    public override void Flush()
    Exceptions
    ExceptionDescription
    System.IO.IOExceptionAn I/O error occurs.
    Remarks

    This may degrade compression for some compression algorithms, so it should be used only when necessary.

    Even if all the inner buffers are flushed, the inner stream will not be complete unless the System.IO.Stream.Close is called. This is because when the CompressedStream is closed it writes the final compressed information to the inner stream; Flush does not.
    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

    CompressedStream Class
    CompressedStream Members
    Base Implementation in Flush
    System.IO.Stream.Close

    Send Feedback