HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
H5PTpublic.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 _H5PTpublic_H
17 #define _H5PTpublic_H
18 
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 /*-------------------------------------------------------------------------
25  *
26  * Create/Open/Close functions
27  *
28  *-------------------------------------------------------------------------
29  */
30 
32  const char *dset_name,
33  hid_t dtype_id,
34  hsize_t chunk_size,
35  int compression );
36 
37 #ifdef VLPT_REMOVED
38 H5_HLDLL hid_t H5PTcreate_vl ( hid_t loc_id,
39  const char *dset_name,
40  hsize_t chunk_size );
41 #endif /* VLPT_REMOVED */
42 
44  const char *dset_name );
45 
46 H5_HLDLL herr_t H5PTclose( hid_t table_id );
47 
48 
49 /*-------------------------------------------------------------------------
50  *
51  * Write functions
52  *
53  *-------------------------------------------------------------------------
54  */
55 
57  size_t nrecords,
58  const void * data );
59 
60 /*-------------------------------------------------------------------------
61  *
62  * Read functions
63  *
64  *-------------------------------------------------------------------------
65  */
66 
67 
69  size_t nrecords,
70  void * data );
71 
73  hsize_t start,
74  size_t nrecords,
75  void *data );
76 
77 /*-------------------------------------------------------------------------
78  *
79  * Inquiry functions
80  *
81  *-------------------------------------------------------------------------
82  */
83 
84 
86  hsize_t *nrecords );
87 
88 H5_HLDLL herr_t H5PTis_valid( hid_t table_id );
89 
90 #ifdef VLPT_REMOVED
91 H5_HLDLL herr_t H5PTis_varlen( hid_t table_id );
92 #endif /* VLPT_REMOVED */
93 
94 /*-------------------------------------------------------------------------
95  *
96  * Packet Table "current index" functions
97  *
98  *-------------------------------------------------------------------------
99  */
100 
102 
104  hsize_t pt_index );
105 
107  hsize_t *pt_index );
108 
109 /*-------------------------------------------------------------------------
110  *
111  * Memory Management functions
112  *
113  *-------------------------------------------------------------------------
114  */
115 
116 #ifdef VLPT_REMOVED
117 H5_HLDLL herr_t H5PTfree_vlen_readbuff( hid_t table_id,
118  size_t bufflen,
119  void * buff );
120 #endif /* VLPT_REMOVED */
121 
122 #ifdef __cplusplus
123 }
124 #endif
125 
126 #endif
127 
GLuint start
Definition: glcorearb.h:474
H5_HLDLL herr_t H5PTread_packets(hid_t table_id, hsize_t start, size_t nrecords, void *data)
int herr_t
Definition: H5public.h:107
H5_HLDLL herr_t H5PTset_index(hid_t table_id, hsize_t pt_index)
unsigned long long hsize_t
Definition: H5public.h:151
H5_HLDLL herr_t H5PTget_next(hid_t table_id, size_t nrecords, void *data)
H5_HLDLL herr_t H5PTget_num_packets(hid_t table_id, hsize_t *nrecords)
H5_HLDLL herr_t H5PTis_valid(hid_t table_id)
H5_HLDLL herr_t H5PTcreate_index(hid_t table_id)
int hid_t
Definition: H5Ipublic.h:56
GLboolean * data
Definition: glcorearb.h:130
H5_HLDLL hid_t H5PTcreate_fl(hid_t loc_id, const char *dset_name, hid_t dtype_id, hsize_t chunk_size, int compression)
#define H5_HLDLL
Definition: H5api_adpt.h:407
H5_HLDLL herr_t H5PTappend(hid_t table_id, size_t nrecords, const void *data)
H5_HLDLL hid_t H5PTopen(hid_t loc_id, const char *dset_name)
H5_HLDLL herr_t H5PTget_index(hid_t table_id, hsize_t *pt_index)
H5_HLDLL herr_t H5PTclose(hid_t table_id)