Removes a conversion function
Procedure:
H5T_UNREGISTER ( type, name, src_id, dst_id, func)
Signature:
herr_t H5Tunregister( H5T_pers_t type, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func )
Parameters:
H5T_pers_t type | IN: Conversion function type:
H5T_PERS_HARD for hard conversion functions or
H5T_PERS_SOFT for soft conversion functions |
const char *name | IN: Name displayed in diagnostic output |
hid_t src_id | IN: Identifier of source datatype |
hid_t dst_id | IN: Identifier of destination datatype |
H5T_conv_t func | IN: Function to convert between source and destination datatypes |
Description:
H5T_UNREGISTER removes a conversion function matching criteria such as soft or hard conversion, source and destination types, and the conversion function.
If a user is trying to remove a conversion function he registered, all parameters can be used. If he is trying to remove a library’s default conversion function, there is no guarantee the name and func parameters will match the user’s chosen values. Passing in some values may cause this function to fail. A good practice is to pass in NULL as their values.
All parameters are optional. The missing parameters will be used to generalize the search criteria.
The conversion function pointer type declaration is described in H5Tregister.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.6.3 | The following change occurred in the H5Tconv_t function:
nelmts parameter type changed to size_t. |
--- Last Modified: January 08, 2020 | 01:08 PM
