Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5Z_UNREGISTER

Unregisters a filter.

Procedure:

H5Z_UNREGISTER(filter)

Signature:

herr_t H5Zunregister(H5Z_filter_t filter)

SUBROUTINE h5zunregister_f(filter, hdferr) 
  IMPLICIT NONE
  INTEGER, INTENT(IN)  :: filter  ! Filter; one of the possible values:
                                  !    H5Z_FILTER_DEFLATE_F
                                  !    H5Z_FILTER_SHUFFLE_F
                                  !    H5Z_FILTER_FLETCHER32_F
                                  !    H5Z_FILTER_SZIP_F
  INTEGER, INTENT(OUT) :: hdferr  ! Error code
                                  ! 0 on success, and -1 on failure
END SUBROUTINE h5zunregister_f

Parameters:
H5Z_filter_t filter    IN: Identifier of the filter to be unregistered. See the introduction to this section of the reference manual for a list of identifiers for standard filters distributed with the HDF5 Library.

Description:

H5Zunregister unregisters the filter specified in filter.

This function first iterates through all opened datasets and groups. If an open object that uses this filter is found, the function will fail with a message indicating that an object using the filter is still open. All open files are then flushed to make sure that all cached data that may use this filter are written out.

If the application is a parallel program, all processes that participate in collective data write should call this function to ensure that all data is flushed.

After a call to H5Zunregister, the filter specified in filter will no longer be available to the application.

Returns:

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

Example:

Coming Soon!

History:
Release    C
1.8.12Function modified to check for open objects using the filter.
1.6.0Function introduced in this release.

--- Last Modified: December 04, 2017 | 07:06 AM