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
h5tb Module Reference
Fortran High Level Table (H5TB) Interface

This module contains Fortran interfaces for H5TB. More...

## Data Types
interface | h5tbinsert_field_f
interface | h5tbread_field_index_f
interface | h5tbread_field_name_f
interface | h5tbwrite_field_index_f
interface | h5tbwrite_field_name_f

## Functions/Subroutines
subroutine | h5tbdelete_field_f (loc_id, dset_name, field_name, errcode)
| Deletes a field from a table.
subroutine | h5tbget_field_info_f (loc_id, dset_name, nfields, field_names, field_sizes, field_offsets, type_size, errcode, maxlen_out)
| Gets information about a table.
subroutine | h5tbget_table_info_f (loc_id, dset_name, nfields, nrecords, errcode)
| Gets the table dimensions.
subroutine | h5tbinsert_field_f (loc_id, dset_name, field_name, field_type, position, buf, errcode)
| Insert a new field into a table.
subroutine | h5tbinsert_field_kind_10_rank_1 (loc_id, dset_name, field_name, field_type, field_index, buf, errcode)
subroutine | h5tbinsert_field_kind_16_rank_1 (loc_id, dset_name, field_name, field_type, field_index, buf, errcode)
subroutine | h5tbinsert_field_kind_4_rank_1 (loc_id, dset_name, field_name, field_type, field_index, buf, errcode)
subroutine | h5tbinsert_field_kind_8_rank_1 (loc_id, dset_name, field_name, field_type, field_index, buf, errcode)
subroutine | h5tbmake_table_f (table_title, loc_id, dset_name, nfields, nrecords, type_size, field_names, field_offset, field_types, chunk_size, compress, errcode)
| Creates (DOES NOT WRITE) a dataset named `dset_name` attached to the object specified by the identifier `loc_id`.
subroutine | h5tbmake_table_f (table_title, loc_id, dset_name, nfields, nrecords, type_size, field_names, field_offset, field_types, chunk_size, fill_data, compress, data, errcode)
| Creates and writes a dataset named `dset_name` attached to the object specified by the identifier `loc_id`.
subroutine | h5tbread_field_index_f (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
| Reads field. The fields are identified by index.
subroutine | h5tbread_field_index_kind_10_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_index_kind_16_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_index_kind_4_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_index_kind_8_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_name_f (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
| Reads one or several fields. The fields are identified by name.
subroutine | h5tbread_field_name_kind_10_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_name_kind_16_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_name_kind_4_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_field_name_kind_8_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbread_table_f (loc_id, dset_name, nfields, dst_size, dst_offset, dst_sizes, dst_buf, errcode)
| Reads a table.
subroutine | h5tbwrite_field_index_f (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
| Overwrites a field.
subroutine | h5tbwrite_field_index_kind_10_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_index_kind_16_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_index_kind_4_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_index_kind_8_rank_1 (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_name_f (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
| Overwrites field.
subroutine | h5tbwrite_field_name_kind_10_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_name_kind_16_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_name_kind_4_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)
subroutine | h5tbwrite_field_name_kind_8_rank_1 (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode)

## Variables
integer, parameter | hltb_max_field_len_f = 255
| Maximum length of a field name buffer returned by h5tbget_field_info_f. Matches HLTB_MAX_FIELD_LEN defined in H5TBpublic.h. Declare field_names character arrays with at least this length: CHARACTER(LEN=HLTB_MAX_FIELD_LEN_F) :: field_names(nfields).

## Detailed Description

This module contains Fortran interfaces for H5TB.

## Function/Subroutine Documentation

## ◆ h5tbinsert_field_kind_10_rank_1()

subroutine h5tbinsert_field_kind_10_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hid_t), intent(in) | field_type,
|  | integer, intent(in) | field_index,
|  | real(kind=10), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbinsert_field_kind_16_rank_1()

subroutine h5tbinsert_field_kind_16_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hid_t), intent(in) | field_type,
|  | integer, intent(in) | field_index,
|  | real(kind=16), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbinsert_field_kind_4_rank_1()

subroutine h5tbinsert_field_kind_4_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hid_t), intent(in) | field_type,
|  | integer, intent(in) | field_index,
|  | real(kind=4), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbinsert_field_kind_8_rank_1()

subroutine h5tbinsert_field_kind_8_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hid_t), intent(in) | field_type,
|  | integer, intent(in) | field_index,
|  | real(kind=8), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_index_kind_10_rank_1()

subroutine h5tbread_field_index_kind_10_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=10), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_index_kind_16_rank_1()

subroutine h5tbread_field_index_kind_16_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=16), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_index_kind_4_rank_1()

subroutine h5tbread_field_index_kind_4_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=4), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_index_kind_8_rank_1()

subroutine h5tbread_field_index_kind_8_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=8), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_name_kind_10_rank_1()

subroutine h5tbread_field_name_kind_10_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=10), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_name_kind_16_rank_1()

subroutine h5tbread_field_name_kind_16_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=16), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_name_kind_4_rank_1()

subroutine h5tbread_field_name_kind_4_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=4), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbread_field_name_kind_8_rank_1()

subroutine h5tbread_field_name_kind_8_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=8), dimension(*), intent(inout), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_index_kind_10_rank_1()

subroutine h5tbwrite_field_index_kind_10_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=10), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_index_kind_16_rank_1()

subroutine h5tbwrite_field_index_kind_16_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=16), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_index_kind_4_rank_1()

subroutine h5tbwrite_field_index_kind_4_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=4), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_index_kind_8_rank_1()

subroutine h5tbwrite_field_index_kind_8_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | integer, intent(in) | field_index,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=8), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_name_kind_10_rank_1()

subroutine h5tbwrite_field_name_kind_10_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=10), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_name_kind_16_rank_1()

subroutine h5tbwrite_field_name_kind_16_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=16), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_name_kind_4_rank_1()

subroutine h5tbwrite_field_name_kind_4_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=4), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## ◆ h5tbwrite_field_name_kind_8_rank_1()

subroutine h5tbwrite_field_name_kind_8_rank_1 | ( | integer(hid_t), intent(in) | loc_id,
|  | character(len=*), intent(in) | dset_name,
|  | character(len=*), intent(in) | field_name,
|  | integer(hsize_t), intent(in) | start,
|  | integer(hsize_t), intent(in) | nrecords,
|  | integer(size_t), intent(in) | type_size,
|  | real(kind=8), dimension(*), intent(in), target | buf,
|  | integer | errcode )

## Variable Documentation

## ◆ hltb_max_field_len_f

integer, parameter hltb_max_field_len_f = 255

Maximum length of a field name buffer returned by h5tbget_field_info_f. Matches HLTB_MAX_FIELD_LEN defined in H5TBpublic.h. Declare field_names character arrays with at least this length: CHARACTER(LEN=HLTB_MAX_FIELD_LEN_F) :: field_names(nfields).