next up previous contents
Next: miset_props_zlib_compression/miget_props_zlib_compression Up: VOLUME PROPERTIES FUNCTIONS (15) Previous: miflush_from_resolution   Contents

miset_props_compression_type/miget_props_compression_type

NAME

miset_props_compression_type, miget_props_compression_type - get or set
the compression type for a volume property list.

SYNOPSIS

#include <minc2.h>

int miset_props_compression_type(mivolumeprops_t        props, 
                                 micompression_t        compression_type);

int miget_props_compression_type(mivolumeprops_t        props,
                                 micompression_t        *compression_type);

DESCRIPTION

Set or retrieve the compression type, if any, for the volume properties.
Currently only two compression types are defined:

Enabling compression will automatically enable blocking with default
parameters (see miset_props_blocking).

typedef enum {
        MI_COMPRESS_NONE = 0,
        MI_COMPRESS_ZLIB = 1
} micompression_t ;

RETURN VALUE

MI_NOERROR on success, or MI_ERROR on failure.



Robert VINCENT 2005-03-09