HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
H5TBpublic.h
Go to the documentation of this file.
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 files COPYING and Copyright.html. COPYING can be found at the root *
9  * of the source code distribution tree; Copyright.html can be found at the *
10  * root level of an installed copy of the electronic HDF5 document set and *
11  * is linked from the top-level documents page. It can also be found at *
12  * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
13  * access to either file, you may request a copy from help@hdfgroup.org. *
14  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 #ifndef _H5TBpublic_H
17 #define _H5TBpublic_H
18 
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 
25 /*-------------------------------------------------------------------------
26  *
27  * Create functions
28  *
29  *-------------------------------------------------------------------------
30  */
31 
32 H5_HLDLL herr_t H5TBmake_table( const char *table_title,
33  hid_t loc_id,
34  const char *dset_name,
35  hsize_t nfields,
36  hsize_t nrecords,
37  size_t type_size,
38  const char *field_names[],
39  const size_t *field_offset,
40  const hid_t *field_types,
41  hsize_t chunk_size,
42  void *fill_data,
43  int compress,
44  const void *buf );
45 
46 
47 /*-------------------------------------------------------------------------
48  *
49  * Write functions
50  *
51  *-------------------------------------------------------------------------
52  */
53 
55  const char *dset_name,
56  hsize_t nrecords,
57  size_t type_size,
58  const size_t *field_offset,
59  const size_t *dst_sizes,
60  const void *buf );
61 
63  const char *dset_name,
64  hsize_t start,
65  hsize_t nrecords,
66  size_t type_size,
67  const size_t *field_offset,
68  const size_t *dst_sizes,
69  const void *buf );
70 
71 
73  const char *dset_name,
74  const char *field_names,
75  hsize_t start,
76  hsize_t nrecords,
77  size_t type_size,
78  const size_t *field_offset,
79  const size_t *dst_sizes,
80  const void *buf );
81 
83  const char *dset_name,
84  hsize_t nfields,
85  const int *field_index,
86  hsize_t start,
87  hsize_t nrecords,
88  size_t type_size,
89  const size_t *field_offset,
90  const size_t *dst_sizes,
91  const void *buf );
92 
93 
94 /*-------------------------------------------------------------------------
95  *
96  * Read functions
97  *
98  *-------------------------------------------------------------------------
99  */
100 
101 
102 
104  const char *dset_name,
105  size_t dst_size,
106  const size_t *dst_offset,
107  const size_t *dst_sizes,
108  void *dst_buf );
109 
110 
112  const char *dset_name,
113  const char *field_names,
114  hsize_t start,
115  hsize_t nrecords,
116  size_t type_size,
117  const size_t *field_offset,
118  const size_t *dst_sizes,
119  void *buf );
120 
122  const char *dset_name,
123  hsize_t nfields,
124  const int *field_index,
125  hsize_t start,
126  hsize_t nrecords,
127  size_t type_size,
128  const size_t *field_offset,
129  const size_t *dst_sizes,
130  void *buf );
131 
132 
134  const char *dset_name,
135  hsize_t start,
136  hsize_t nrecords,
137  size_t type_size,
138  const size_t *dst_offset,
139  const size_t *dst_sizes,
140  void *buf );
141 
142 /*-------------------------------------------------------------------------
143  *
144  * Inquiry functions
145  *
146  *-------------------------------------------------------------------------
147  */
148 
149 
151  const char *dset_name,
152  hsize_t *nfields,
153  hsize_t *nrecords );
154 
156  const char *dset_name,
157  char *field_names[],
158  size_t *field_sizes,
159  size_t *field_offsets,
160  size_t *type_size );
161 
162 
163 /*-------------------------------------------------------------------------
164  *
165  * Manipulation functions
166  *
167  *-------------------------------------------------------------------------
168  */
169 
170 
172  const char *dset_name,
173  hsize_t start,
174  hsize_t nrecords );
175 
176 
178  const char *dset_name,
179  hsize_t start,
180  hsize_t nrecords,
181  size_t dst_size,
182  const size_t *dst_offset,
183  const size_t *dst_sizes,
184  void *buf );
185 
187  const char *dset_name1,
188  hsize_t start1,
189  hsize_t nrecords,
190  const char *dset_name2,
191  hsize_t start2 );
192 
194  const char *dset_name1,
195  hid_t loc_id2,
196  const char *dset_name2,
197  const char *dset_name3 );
198 
200  const char *dset_name,
201  const char *field_name,
202  hid_t field_type,
203  hsize_t position,
204  const void *fill_data,
205  const void *buf );
206 
208  const char *dset_name,
209  const char *field_name );
210 
211 
212 /*-------------------------------------------------------------------------
213  *
214  * Table attribute functions
215  *
216  *-------------------------------------------------------------------------
217  */
218 
220  char *table_title );
221 
223  const char *dset_name,
224  hid_t dset_id,
225  unsigned char *dst_buf);
226 
227 #ifdef __cplusplus
228 }
229 #endif
230 
231 
232 #endif
233 
H5_HLDLL 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)
H5_HLDLL 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)
H5_HLDLL htri_t H5TBAget_fill(hid_t loc_id, const char *dset_name, hid_t dset_id, unsigned char *dst_buf)
GLuint start
Definition: glcorearb.h:474
H5_HLDLL herr_t H5TBAget_title(hid_t loc_id, char *table_title)
int herr_t
Definition: H5public.h:107
H5_HLDLL herr_t H5TBcombine_tables(hid_t loc_id1, const char *dset_name1, hid_t loc_id2, const char *dset_name2, const char *dset_name3)
unsigned long long hsize_t
Definition: H5public.h:151
H5_HLDLL 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)
H5_HLDLL 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)
H5_HLDLL 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)
H5_HLDLL 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)
H5_HLDLL herr_t H5TBdelete_record(hid_t loc_id, const char *dset_name, hsize_t start, hsize_t nrecords)
H5_HLDLL 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)
H5_HLDLL herr_t H5TBdelete_field(hid_t loc_id, const char *dset_name, const char *field_name)
int hid_t
Definition: H5Ipublic.h:56
H5_HLDLL 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)
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glcorearb.h:2539
H5_HLDLL 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)
H5_HLDLL 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)
H5_HLDLL herr_t H5TBget_table_info(hid_t loc_id, const char *dset_name, hsize_t *nfields, hsize_t *nrecords)
H5_HLDLL 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)
#define H5_HLDLL
Definition: H5api_adpt.h:407
H5_HLDLL 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)
H5_HLDLL 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)
int htri_t
Definition: H5public.h:126