Reads a table

Procedure:

H5TB_READ_TABLE (loc_id, table_name, dst_size, dst_offset, dst_sizes, dst_buf )

Signature:

<pre><code class="language-c">herr_t H5TBread_table(hid_t loc_id,
                      const char *dset_name,
                      size_t type_size,
                      const size_t *field_offset,
                      const size_t *field_sizes,
                      void *dst_buf)</code></pre>

<pre><code class="language-fortran">subroutine h5tbread_table_f(loc_id, table_name, nfields, dst_size, dst_offset, &
                             dst_sizes, dst_buf, errcode)

    integer(HID_T),   intent(IN) :: loc_id                            ! An array containing the sizes of the fields
    character(LEN=*), intent(IN) :: table_name                        ! The name of the dataset to read
    integer(HSIZE_T), intent(IN) :: nfields                           ! number of fields
    integer(SIZE_T),  intent(IN) :: dst_size                          ! The size of the structure type
    integer(SIZE_T),  dimension(1:nfields), intent(IN) :: dst_offset  ! An array containing the offsets of the fields
    integer(SIZE_T),  dimension(1:nfields), intent(IN) :: dst_sizes   ! An array containing the sizes of the fields
    type(C_PTR), intent(out) :: dst_buf                               ! Buffer with data
    integer :: errcode                                                ! error code</code></pre>

Parameters:
hid_t loc_idIN: Identifier of the file or group to read the table within
const char *table_nameIN: The name of the dataset to read
size_t dst_sizeIN: The size of the structure type, as calculated by sizeof()
const size_t *dst_offsetIN: An array containing the offsets of the fields. These offsets can be calculated with the HOFFSET macro.
const size_t  *dst_sizesIN: An array containing the sizes of the fields. These sizes can be calculated with the sizeof() macro.
void *dst_bufOUT: Buffer with data

Description:

H5TB_READ_TABLE reads a table named table_name attached to the object specified by the identifier loc_id

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example: