Please, help us to better know about our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5  1.8.23
C-API Reference
Modules
H5P

Detailed Description

Use the functions in this module to manage HDF5 property lists and property list classes. HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions.

Typically, property lists are created by instantiating one of the built-in or user-defined property list classes. After adding suitable properties, property lists are used when opening or creating HDF5 items, or when reading or writing data. Property lists can be modified by adding or changing properties. Property lists are deleted by closing the associated handles.

CreateRead
15 {
16 __label__ fail_dcpl;
17 hid_t dcpl;
18
19 // every property list is created as an instance of a suitable
20 // property list class
21 if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) == H5I_INVALID_HID) {
22 ret_val = EXIT_FAILURE;
23 goto fail_dcpl;
24 }
25
26 // ...
27
28 H5Pclose(dcpl);
29fail_dcpl:;
30 }
H5I_INVALID_HID
#define H5I_INVALID_HID
Definition: H5Ipublic.h:66
hid_t
int hid_t
Definition: H5Ipublic.h:60
H5P_DATASET_CREATE
#define H5P_DATASET_CREATE
Definition: H5Ppublic.h:216
H5Pclose
herr_t H5Pclose(hid_t plist_id)
Terminates access to a property list.
H5Pcreate
hid_t H5Pcreate(hid_t cls_id)
Creates a new property list as an instance of a property list class.
34 {
35 __label__ fail_dcpl, fail_plist_cls_id;
36 hid_t dcpl, plist_cls_id;
37
38 if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) == H5I_INVALID_HID) {
39 ret_val = EXIT_FAILURE;
40 goto fail_dcpl;
41 }
42 // to perform introspection on any kind of property list,
43 // we need to determine its property list class by obtaining a handle
44 if ((plist_cls_id = H5Pget_class(dcpl)) == H5I_INVALID_HID) {
45 ret_val = EXIT_FAILURE;
46 goto fail_plist_cls_id;
47 }
48 // Compare the handle to the handles of built-in or user-defined
49 // property list classes
50 assert(H5Pequal(plist_cls_id, H5P_DATASET_CREATE) > 0);
51
52fail_plist_cls_id:
53 H5Pclose(dcpl);
54fail_dcpl:;
55 }
H5Pequal
htri_t H5Pequal(hid_t id1, hid_t id2)
Compares two property lists or classes for equality.
H5Pget_class
hid_t H5Pget_class(hid_t plist_id)
Returns the property list class identifier for a property list.
UpdateDelete
59 {
60 __label__ fail_dcpl, fail_prop;
61 hid_t dcpl;
62
63 if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) == H5I_INVALID_HID) {
64 ret_val = EXIT_FAILURE;
65 goto fail_dcpl;
66 }
67
68 // a property list is updated by adding (or removing) properties
69 if (H5Pset_fill_time(dcpl, H5D_FILL_TIME_NEVER) < 0) {
70 ret_val = EXIT_FAILURE;
71 goto fail_prop;
72 }
73
74fail_prop:
75 H5Pclose(dcpl);
76fail_dcpl:;
77 }
H5D_FILL_TIME_NEVER
@ H5D_FILL_TIME_NEVER
Definition: H5Dpublic.h:138
H5Pset_fill_time
herr_t H5Pset_fill_time(hid_t plist_id, H5D_fill_time_t fill_time)
Sets the time when fill values are written to a dataset.
81 {
82 __label__ fail_dcpl;
83 hid_t dcpl;
84
85 if ((dcpl = H5Pcreate(H5P_DATASET_CREATE)) == H5I_INVALID_HID) {
86 ret_val = EXIT_FAILURE;
87 goto fail_dcpl;
88 }
89
90 // a property list is "deleted" by closing it
91 H5Pclose(dcpl);
92fail_dcpl:;
93 }

Modules

 Attribute and Link Creation Properties
 
 Dataset Access Properties
 
 Dataset Creation Properties
 
 Dataset Transfer Properties
 
 File Access Properties
 
 File Creation Properties
 
 General Access Properties
 
 General Property List Operations
 
 General Property List Operations (Advanced)
 
 Group Creation Properties
 
 Link Access Properties
 
 Object Copy Properties
 
 Object Creation Properties