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
H5Tdevelop.h File Reference
`#include "H5Tpublic.h"`

## Data Structures
struct | H5T_cdata_t

## Typedefs
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)

## Enumerations
enum | H5T_bkg_t { H5T_BKG_NO = 0 , H5T_BKG_TEMP = 1 , H5T_BKG_YES = 2 }
enum | H5T_cmd_t { H5T_CONV_INIT = 0 , H5T_CONV_CONV = 1 , H5T_CONV_FREE = 2 }
enum | H5T_pers_t { H5T_PERS_DONTCARE = -1 , H5T_PERS_HARD = 0 , H5T_PERS_SOFT = 1 }

## Functions
htri_t | H5Tcompiler_conv (hid_t src_id, hid_t dst_id)
| Check whether the library's default conversion is hard conversion.
H5T_conv_t | H5Tfind (hid_t src_id, hid_t dst_id, H5T_cdata_t **pcdata)
| Finds a conversion function.
herr_t | H5Tregister (H5T_pers_t pers, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func)
| Registers a datatype conversion function.
herr_t | H5Tunregister (H5T_pers_t pers, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func)
| Removes a conversion function.

## Typedef Documentation

## ◆ H5T_conv_t

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)

All datatype conversion functions are...

## Enumeration Type Documentation

## ◆ H5T_bkg_t

enum H5T_bkg_t

How is the bkg buffer used by the conversion function?

Enumerator
H5T_BKG_NO | background buffer is not needed, send NULL
H5T_BKG_TEMP | bkg buffer used as temp storage only
H5T_BKG_YES | init bkg buf with data before conversion

## ◆ H5T_cmd_t

enum H5T_cmd_t

Commands sent to conversion functions

Enumerator
H5T_CONV_INIT | query and/or initialize private data
H5T_CONV_CONV | convert data from source to dest datatype
H5T_CONV_FREE | function is being removed from path

## ◆ H5T_pers_t

enum H5T_pers_t

Conversion function persistence

Enumerator
H5T_PERS_DONTCARE | wild card
H5T_PERS_HARD | hard conversion function
H5T_PERS_SOFT | soft conversion function