Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2026-03-23 The HDF5 Field Guide

Loading...
Searching...
No Matches
Java Filter (H5Z) Interface

## Detailed Description

See also
  Filters (H5Z), C-API
  HDF5 Filters, User Guide

## Functions
static synchronized native int | H5Zfilter_avail (int filter) throws HDF5LibraryException
static synchronized native int | H5Zget_filter_info (int filter) throws HDF5LibraryException
static synchronized native int | H5Zunregister (int filter) throws HDF5LibraryException

## Function Documentation

## ◆ H5Zfilter_avail()

synchronized native int H5Zfilter_avail | ( | int | filter | ) | throws HDF5LibraryException
| static

H5Zfilter_avail checks if a filter is available.

Parameters

  filter | IN: filter number.

Returns
  a non-negative(TRUE/FALSE) value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Zget_filter_info()

synchronized native int H5Zget_filter_info | ( | int | filter | ) | throws HDF5LibraryException
| static

H5Zget_filter_info gets information about a pipeline data filter.

Parameters

  filter | IN: filter number.

Returns
  the filter information flags

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Zunregister()

synchronized native int H5Zunregister | ( | int | filter | ) | throws HDF5LibraryException
| static

H5Zunregister unregisters a filter.

Parameters

  filter | IN: filter number.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.