default_file_compression Property
The default compression mode to use when creating files and alternate streams.
Syntax
def get_default_file_compression() -> int: ... def set_default_file_compression(value: int) -> None: ...
default_file_compression = property(get_default_file_compression, set_default_file_compression)
Default Value
0
Remarks
This property specifies the default compression mode that the class should use when creating files and alternate streams. Valid values are:
CBFSSTORAGE_CM_NONE | 0 | Don't use compression. |
CBFSSTORAGE_CM_DEFAULT | 1 | Use default compression (zlib). |
CBFSSTORAGE_CM_CUSTOM | 2 | Use event-based custom compression.
Compression level is not used. |
CBFSSTORAGE_CM_ZLIB | 3 | Use zlib compression.
Valid compression levels are 1-9. |
CBFSSTORAGE_CM_RLE | 4 | Use RLE compression.
Compression level is not used. |
Applications that use custom compression must the on_data_compress and on_data_decompress events. Please refer to the Compression topic for more information.
Applications can also specify a default compression level using the DefaultFileCompressionLevel configuration setting, if desired.