util/X86LINUX64/include/H5TBpublic.h

   1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
   2  * Copyright by The HDF Group.                                               *
   3  * Copyright by the Board of Trustees of the University of Illinois.         *
   4  * All rights reserved.                                                      *
   5  *                                                                           *
   6  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
   7  * terms governing use, modification, and redistribution, is contained in    *
   8  * the COPYING file, which can be found at the root of the source code       *
   9  * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
  10  * If you do not have access to either file, you may request a copy from     *
  11  * help@hdfgroup.org.                                                        *
  12  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  13
  14 #ifndef _H5TBpublic_H
  15 #define _H5TBpublic_H
  16
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22
  23 /*-------------------------------------------------------------------------
  24  *
  25  * Create functions
  26  *
  27  *-------------------------------------------------------------------------
  28  */
  29
  30 H5_HLDLL herr_t  H5TBmake_table( const char *table_title,
  31                        hid_t loc_id,
  32                        const char *dset_name,
  33                        hsize_t nfields,
  34                        hsize_t nrecords,
  35                        size_t type_size,
  36                        const char *field_names[],
  37                        const size_t *field_offset,
  38                        const hid_t *field_types,
  39                        hsize_t chunk_size,
  40                        void *fill_data,
  41                        int compress,
  42                        const void *buf );
  43
  44
  45 /*-------------------------------------------------------------------------
  46  *
  47  * Write functions
  48  *
  49  *-------------------------------------------------------------------------
  50  */
  51
  52 H5_HLDLL herr_t  H5TBappend_records( hid_t loc_id,
  53                            const char *dset_name,
  54                            hsize_t nrecords,
  55                            size_t type_size,
  56                            const size_t *field_offset,
  57                            const size_t *dst_sizes,
  58                            const void *buf );
  59
  60 H5_HLDLL herr_t  H5TBwrite_records( hid_t loc_id,
  61                           const char *dset_name,
  62                           hsize_t start,
  63                           hsize_t nrecords,
  64                           size_t type_size,
  65                           const size_t *field_offset,
  66                           const size_t *dst_sizes,
  67                           const void *buf );
  68
  69
  70 H5_HLDLL herr_t  H5TBwrite_fields_name( hid_t loc_id,
  71                               const char *dset_name,
  72                               const char *field_names,
  73                               hsize_t start,
  74                               hsize_t nrecords,
  75                               size_t type_size,
  76                               const size_t *field_offset,
  77                               const size_t *dst_sizes,
  78                               const void *buf );
  79
  80 H5_HLDLL herr_t  H5TBwrite_fields_index( hid_t loc_id,
  81                                const char *dset_name,
  82                                hsize_t nfields,
  83                                const int *field_index,
  84                                hsize_t start,
  85                                hsize_t nrecords,
  86                                size_t type_size,
  87                                const size_t *field_offset,
  88                                const size_t *dst_sizes,
  89                                const void *buf );
  90
  91
  92 /*-------------------------------------------------------------------------
  93  *
  94  * Read functions
  95  *
  96  *-------------------------------------------------------------------------
  97  */
  98
  99
 100
 101 H5_HLDLL herr_t  H5TBread_table( hid_t loc_id,
 102                        const char *dset_name,
 103                        size_t dst_size,
 104                        const size_t *dst_offset,
 105                        const size_t *dst_sizes,
 106                        void *dst_buf );
 107
 108
 109 H5_HLDLL herr_t  H5TBread_fields_name( hid_t loc_id,
 110                              const char *dset_name,
 111                              const char *field_names,
 112                              hsize_t start,
 113                              hsize_t nrecords,
 114                              size_t type_size,
 115                              const size_t *field_offset,
 116                              const size_t *dst_sizes,
 117                              void *buf );
 118
 119 H5_HLDLL herr_t  H5TBread_fields_index( hid_t loc_id,
 120                               const char *dset_name,
 121                               hsize_t nfields,
 122                               const int *field_index,
 123                               hsize_t start,
 124                               hsize_t nrecords,
 125                               size_t type_size,
 126                               const size_t *field_offset,
 127                               const size_t *dst_sizes,
 128                               void *buf );
 129
 130
 131 H5_HLDLL herr_t  H5TBread_records( hid_t loc_id,
 132                          const char *dset_name,
 133                          hsize_t start,
 134                          hsize_t nrecords,
 135                          size_t type_size,
 136                          const size_t *dst_offset,
 137                          const size_t *dst_sizes,
 138                          void *buf );
 139
 140 /*-------------------------------------------------------------------------
 141  *
 142  * Inquiry functions
 143  *
 144  *-------------------------------------------------------------------------
 145  */
 146
 147
 148 H5_HLDLL herr_t  H5TBget_table_info ( hid_t loc_id,
 149                             const char *dset_name,
 150                             hsize_t *nfields,
 151                             hsize_t *nrecords );
 152
 153 H5_HLDLL herr_t  H5TBget_field_info( hid_t loc_id,
 154                            const char *dset_name,
 155                            char *field_names[],
 156                            size_t *field_sizes,
 157                            size_t *field_offsets,
 158                            size_t *type_size );
 159
 160
 161 /*-------------------------------------------------------------------------
 162  *
 163  * Manipulation functions
 164  *
 165  *-------------------------------------------------------------------------
 166  */
 167
 168
 169 H5_HLDLL herr_t  H5TBdelete_record( hid_t loc_id,
 170                           const char *dset_name,
 171                           hsize_t start,
 172                           hsize_t nrecords );
 173
 174
 175 H5_HLDLL herr_t  H5TBinsert_record( hid_t loc_id,
 176                           const char *dset_name,
 177                           hsize_t start,
 178                           hsize_t nrecords,
 179                           size_t dst_size,
 180                           const size_t *dst_offset,
 181                           const size_t *dst_sizes,
 182                           void *buf );
 183
 184 H5_HLDLL herr_t  H5TBadd_records_from( hid_t loc_id,
 185                              const char *dset_name1,
 186                              hsize_t start1,
 187                              hsize_t nrecords,
 188                              const char *dset_name2,
 189                              hsize_t start2 );
 190
 191 H5_HLDLL herr_t  H5TBcombine_tables( hid_t loc_id1,
 192                            const char *dset_name1,
 193                            hid_t loc_id2,
 194                            const char *dset_name2,
 195                            const char *dset_name3 );
 196
 197 H5_HLDLL herr_t  H5TBinsert_field( hid_t loc_id,
 198                          const char *dset_name,
 199                          const char *field_name,
 200                          hid_t field_type,
 201                          hsize_t position,
 202                          const void *fill_data,
 203                          const void *buf );
 204
 205 H5_HLDLL herr_t  H5TBdelete_field( hid_t loc_id,
 206                          const char *dset_name,
 207                          const char *field_name );
 208
 209
 210 /*-------------------------------------------------------------------------
 211  *
 212  * Table attribute functions
 213  *
 214  *-------------------------------------------------------------------------
 215  */
 216
 217 H5_HLDLL herr_t  H5TBAget_title( hid_t loc_id,
 218                        char *table_title );
 219
 220 H5_HLDLL htri_t  H5TBAget_fill(hid_t loc_id,
 221                       const char *dset_name,
 222                       hid_t dset_id,
 223                       unsigned char *dst_buf);
 224
 225 #ifdef __cplusplus
 226 }
 227 #endif
 228
 229
 230 #endif
 231