Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kDat5Serializer_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 kLoad5.

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

  object | Object to be serialized.
  filePath | Path of the file to save.
  algorithm | Compression algorithm type.
  level | Compression level; accepts kCompressionPreset value or compressor-specific value.

Returns
  Operation status.