Xceed .NET Libraries Documentation
Xceed.Compression Assembly / Xceed.Compression Namespace / CompressedStream Class / WillUseCompression Method
The compression method.
The compression level.


In This Topic
    WillUseCompression Method
    In This Topic
    Determines whether a compression format will be used, based on a specified compression method and level.
    Syntax
    'Declaration
     
    
    Public Shared Function WillUseCompression( _
       ByRef method As CompressionMethod, _
       ByRef level As CompressionLevel _
    ) As Boolean
    'Usage
     
    
    Dim method As CompressionMethod
    Dim level As CompressionLevel
    Dim value As Boolean
     
    value = CompressedStream.WillUseCompression(method, level)
    public static bool WillUseCompression( 
       ref CompressionMethod method,
       ref CompressionLevel level
    )

    Parameters

    method
    The compression method.
    level
    The compression level.

    Return Value

    true if compression will be used; false otherwise.
    Remarks

    The method changes the specified values if necessary. If the specified compression method is Stored, it sets the compression level to Normal.

    If the specified compression level is None, it sets the compression method to Stored unless the Deflated or Deflated64 compression method has been specified, since these methods support writing uncompressed data in their format.

    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