Last modified: 15 June 2010
Name: H5Pset_deflate
Signature:
herr_t H5Pset_deflate( hid_t plist_id, uint level )

Purpose:
Sets deflate (GNU gzip) compression method and compression level.

Description:
H5Pset_deflate sets the deflate compression method for a dataset or group creation property list to H5Z_FILTER_DEFLATE and the compression level to level, which should be a value from zero to nine, inclusive.

Lower compression levels are faster but result in less compression.

HDF5 relies on GNU gzip for this compression (see zlib).

Parameters:
hid_t plist_id     IN: Dataset or group creation property list identifier.
uint level IN: Compression level.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface: h5pset_deflate_f
SUBROUTINE h5pset_deflate_f(prp_id, level, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
  INTEGER, INTENT(IN)        :: level  ! Compression level 
  INTEGER, INTENT(OUT)       :: hdferr ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pset_deflate_f
        

History:
Release     Change
1.8.5 Function extended to work with group creation property lists.