Function

compression_stream_init

Initializes a compression stream for either compression or decompression.

Declaration

compression_status compression_stream_init(compression_stream *stream, compression_stream_operation operation, compression_algorithm algorithm);

Parameters

stream

Pointer to an allocated compression_stream structure.

operation

A constant of type compression_stream_operation used to indicate the stream operation.

algorithm

Return Value

A value of type compression_status, interpreted as follows:

Discussion

After success of this function, set the dst_ptr, dst_size, src_ptr, and src_size fields of the stream structure to their respective values. You can then pass stream structure to the compression_stream_process function.

See Also

Multiple-Step Compression

Compressing and Decompressing Files with Stream Compression

Perform compression or the appropriate kind of decompression to a file based on its path extension.

compression_stream

A structure representing a compression stream.

compression_stream_process

Performs compression or decompression using an initialized compression stream structure.

compression_stream_destroy

Frees any memory allocated by stream initialization function.

compression_status

A set of values used to represent the status of stream compression.

compression_stream_flags

A set of values used to represent stream compression flags.

compression_stream_operation

A set of values used to represent a stream compression operation.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software