Class H5Z

Inheritance
System.Object
H5Z
Namespace: HDF.PInvoke
Assembly: HDF.PInvoke.dll
Syntax
public sealed class H5Z : object

Fields

| Improve this Doc View Source

CONFIG_DECODE_ENABLED

Declaration
public const uint CONFIG_DECODE_ENABLED = null
Field Value
Type Description
System.UInt32
| Improve this Doc View Source

CONFIG_ENCODE_ENABLED

Declaration
public const uint CONFIG_ENCODE_ENABLED = null
Field Value
Type Description
System.UInt32

Methods

filter_avail(H5Z.filter_t)

Determines whether a filter is available. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-FilterAvail

Declaration
public static System.Int32 filter_avail(H5Z.filter_t filter)
Parameters
Type Name Description
H5Z.filter_t filter

Filter identifier.
Returns
Type Description
System.Int32

Returns a Boolean value if successful; otherwise returns a negative value.

get_filter_info(H5Z.filter_t, ref UInt32)

Retrieves information about a filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-GetFilterInfo

Declaration
public static System.Int32 get_filter_info(H5Z.filter_t filter, ref uint filter_config)
Parameters
Type Name Description
H5Z.filter_t filter

Identifier of the filter to query.
System.UInt32 filter_config

A bit field encoding the returned filter information
Returns
Type Description
System.Int32

Returns a non-negative value on success, a negative value on failure.

register(ref H5Z.class_t)

Registers new filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-Register

Declaration
public static System.Int32 register(ref H5Z.class_t filter_class)
Parameters
Type Name Description
H5Z.class_t filter_class

A pointer to a buffer for the struct containing filter-definition information.
Returns
Type Description
System.Int32

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

unregister(H5Z.filter_t)

Unregisters a filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-Unregister

Declaration
public static System.Int32 unregister(H5Z.filter_t filter)
Parameters
Type Name Description
H5Z.filter_t filter

Identifier of the filter to be unregistered.
Returns
Type Description
System.Int32

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