HDF5 1.14.5
API Reference
|
Functions | |
herr_t | H5Tinsert (hid_t parent_id, const char *name, size_t offset, hid_t member_id) |
Adds a new member to a compound datatype. | |
herr_t | H5Tpack (hid_t type_id) |
Recursively removes padding from within a compound datatype. | |
size_t | H5Tget_member_offset (hid_t type_id, unsigned membno) |
Retrieves the offset of a field of a compound datatype. | |
H5T_class_t | H5Tget_member_class (hid_t type_id, unsigned membno) |
Returns datatype class of compound datatype member. | |
hid_t | H5Tget_member_type (hid_t type_id, unsigned membno) |
Returns the datatype of the specified member. | |
H5T_class_t H5Tget_member_class | ( | hid_t | type_id, |
unsigned | membno | ||
) |
Returns datatype class of compound datatype member.
[in] | type_id | Datatype identifier |
[in] | membno | Zero-based index of the field or element |
Given a compound datatype, dtype_id
, H5Tget_member_class() returns the datatype class of the member specified by member_no
.
Valid class identifiers, as defined in H5Tpublic.h, are:
size_t H5Tget_member_offset | ( | hid_t | type_id, |
unsigned | membno | ||
) |
Retrieves the offset of a field of a compound datatype.
[in] | type_id | Datatype identifier |
[in] | membno | Zero-based index of the field or element |
H5Tget_member_offset() retrieves the byte offset of the beginning of a field within a compound datatype with respect to the beginning of the compound datatype datum.
Note that zero is a valid offset and that this function will fail only if a call to H5Tget_member_class() fails with the same arguments.
member_no
parameter type changed to unsigned.Returns the datatype of the specified member.
[in] | type_id | Datatype identifier |
[in] | membno | Zero-based index of the field or element |
H5Tget_member_type() returns the datatype of the specified member. The caller should invoke H5Tclose() to release resources associated with the type.
membno
parameter type changed to unsigned.Adds a new member to a compound datatype.
[in] | parent_id | Datatype identifier |
[in] | name | Name of the field to insert |
[in] | offset | Offset in memory structure of the field to insert |
[in] | member_id | Datatype identifier of the field to insert |
H5Tinsert() adds another member to the compound datatype, specified type_id
.
The new member has a name
which must be unique within the compound datatype. The offset
argument defines the start of the member in an instance of the compound datatype, and member_id
is the datatype identifier of the new member.
Recursively removes padding from within a compound datatype.
[in] | type_id | Datatype identifier |
H5Tpack() recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data.