Name: H5Tregister
Signature:
herr_t H5Tregister( H5T_pers_t pers, const char * name, hid_t src_id, hid_t dst_id, H5T_conv_t func )
Purpose:
Registers a conversion function.
Description:
H5Tregister registers a hard or soft conversion function for a datatype conversion path.

The parameter pers indicates whether a conversion function is hard (H5T_PERS_HARD) or soft (H5T_PERS_SOFT).

A conversion path can have only one hard function. When pers is H5T_PERS_HARD, func replaces any previous hard function. If pers is H5T_PERS_HARD and func is the null pointer, then any hard function registered for this path is removed.

When pers is H5T_PERS_SOFT, H5Tregister adds the function to the end of the master soft list and replaces the soft function in all applicable existing conversion paths. Soft functions are used when determining which conversion function is appropriate for this path.

The name is used only for debugging and should be a short identifier for the function.

The path is specified by the source and destination datatypes src_id and dst_id. For soft conversion functions, only the class of these types is important.

The type of the conversion function pointer is declared as:

typedef herr_t (*H5T_conv_t) (hid_t src_id, 
                              hid_t dst_id, 
                              H5T_cdata_t *cdata,
                              size_t nelmts, 
                              size_t buf_stride, 
                              size_t bkg_stride, 
                              void *buf, 
                              void *bkg,
                              hid_t dset_xfer_plist)

The H5T_cdata_t struct is declared as:

typedef struct *H5T_cdata_t (H5T_cmd_t command, 
                             H5T_bkg_t need_bkg, 
                             hbool_t *recalc,
                             void *priv)

The H5T_conv_t parameters and the elements of the H5T_cdata_t struct are described more fully in the “Data Conversion” section of  “The Datatype Interface (H5T)” in the HDF5 User's Guide.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.
History: