Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kDat6Serializer_SaveCompressed ( kObject  object,
const kChar filePath,
kCompressionType  algorithm,
k32s  level 
)

Saves an object to file using the specified compression type.

The file produced by this function can be loaded with kSerializer_LoadObject or kLoad6.

The Zen library does not itself provide compression algorithms. If compression support is required, an additional assembly that implements compression must first be loaded. Refer to the documentation for the selected compression stream type for information about additional requirements or restrictions that might apply.

Support for this feature was introduced in Zen 6.2.1. Older versions cannot read or write compressed content.

Parameters
objectObject to be serialized.
filePathPath of the file to save.
algorithmCompression algorithm type.
levelCompression level; accepts kCompressionPreset value or compressor-specific value.
Returns
Operation status.