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

| HDF5 Last Updated on 2026-07-28 The HDF5 Field Guide

Loading...
Searching...
No Matches
H5TBpublic.h File Reference

## Macros
#define | HLTB_MAX_FIELD_LEN 255

## Functions
H5HL_DLL herr_t | H5TBadd_records_from (hid_t loc_id, const char *dset_name1, hsize_t start1, hsize_t nrecords, const char *dset_name2, hsize_t start2)
| Add records from first table to second table.
H5HL_DLL htri_t | H5TBAget_fill (hid_t loc_id, const char *dset_name, hid_t dset_id, unsigned char *dst_buf)
| Reads the table attribute fill values.
H5HL_DLL herr_t | H5TBAget_title (hid_t loc_id, char *table_title)
| Reads a table's title.
H5HL_DLL herr_t | H5TBappend_records (hid_t loc_id, const char *dset_name, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf)
| Adds records to the end of the table.
H5HL_DLL herr_t | H5TBcombine_tables (hid_t loc_id1, const char *dset_name1, hid_t loc_id2, const char *dset_name2, const char *dset_name3)
| Combines records from two tables into a third.
H5HL_DLL herr_t | H5TBdelete_field (hid_t loc_id, const char *dset_name, const char *field_name)
| Deletes a field from a table.
H5HL_DLL herr_t | H5TBdelete_record (hid_t loc_id, const char *dset_name, hsize_t start, hsize_t nrecords)
| Delete records.
H5HL_DLL herr_t | H5TBget_field_info (hid_t loc_id, const char *dset_name, char *field_names[], size_t *field_sizes, size_t *field_offsets, size_t *type_size)
| Gets information about a table.
H5HL_DLL herr_t | H5TBget_table_info (hid_t loc_id, const char *dset_name, hsize_t *nfields, hsize_t *nrecords)
| Gets the table dimensions.
H5HL_DLL herr_t | H5TBinsert_field (hid_t loc_id, const char *dset_name, const char *field_name, hid_t field_type, hsize_t position, const void *fill_data, const void *buf)
| Insert a new field into a table.
H5HL_DLL herr_t | H5TBinsert_record (hid_t loc_id, const char *dset_name, hsize_t start, hsize_t nrecords, size_t dst_size, const size_t *dst_offset, const size_t *dst_sizes, void *buf)
| Insert records.
H5HL_DLL herr_t | H5TBmake_table (const char *table_title, hid_t loc_id, const char *dset_name, hsize_t nfields, hsize_t nrecords, size_t type_size, const char *field_names[], const size_t *field_offset, const hid_t *field_types, hsize_t chunk_size, void *fill_data, int compress, const void *buf)
| Creates and writes a table.
H5HL_DLL herr_t | H5TBread_fields_index (hid_t loc_id, const char *dset_name, hsize_t nfields, const int *field_index, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, void *buf)
| Reads one or several fields. The fields are identified by index.
H5HL_DLL herr_t | H5TBread_fields_name (hid_t loc_id, const char *dset_name, const char *field_names, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, void *buf)
| Reads one or several fields. The fields are identified by name.
H5HL_DLL herr_t | H5TBread_records (hid_t loc_id, const char *dset_name, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *dst_offset, const size_t *dst_sizes, void *buf)
| Reads records.
H5HL_DLL herr_t | H5TBread_table (hid_t loc_id, const char *dset_name, size_t dst_size, const size_t *dst_offset, const size_t *dst_sizes, void *dst_buf)
| Reads a table.
H5HL_DLL herr_t | H5TBwrite_fields_index (hid_t loc_id, const char *dset_name, hsize_t nfields, const int *field_index, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf)
| Overwrites fields.
H5HL_DLL herr_t | H5TBwrite_fields_name (hid_t loc_id, const char *dset_name, const char *field_names, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf)
| Overwrites fields.
H5HL_DLL herr_t | H5TBwrite_records (hid_t loc_id, const char *dset_name, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf)
| Overwrites records.

## Macro Definition Documentation

## ◆ HLTB_MAX_FIELD_LEN

#define HLTB_MAX_FIELD_LEN 255

Maximum length (including null terminator) of a table field name in the HDF5 Table API. Field names passed to H5TBmake_table() that exceed HLTB_MAX_FIELD_LEN - 1 characters are silently truncated when read back by H5TBget_field_info(). Caller-provided output buffers in field_names[] must be at least this many bytes each.

Since
  2.2.0