![]() |
HDF5
1.15.0.207d749
API Reference
|
Modules | |
Compound Datatypes | |
Enumeration Datatypes | |
Functions | |
int | H5Tget_nmembers (hid_t type_id) |
Retrieves the number of elements in a compound or enumeration datatype. More... | |
char * | H5Tget_member_name (hid_t type_id, unsigned membno) |
Retrieves the name of a compound or enumeration datatype member. More... | |
int | H5Tget_member_index (hid_t type_id, const char *name) |
Retrieves the index of a compound or enumeration datatype member. More... | |
int H5Tget_member_index | ( | hid_t | type_id, |
const char * | name | ||
) |
Retrieves the index of a compound or enumeration datatype member.
[in] | type_id | Datatype identifier |
[in] | name | Name of the field or member |
H5Tget_member_index() retrieves the index of a field of a compound datatype or an element of an enumeration datatype.
The name of the target field or element is specified by name
.
Fields are stored in no particular order with index values of 0 through N-1, where N is the value returned by H5Tget_nmembers() .
char* H5Tget_member_name | ( | hid_t | type_id, |
unsigned | membno | ||
) |
Retrieves the name of a compound or enumeration datatype member.
[in] | type_id | Datatype identifier |
[in] | membno | Zero-based index of the field or element |
H5Tget_member_name() retrieves the name of a field of a compound datatype or an element of an enumeration datatype.
The index of the target field or element is specified in member_no
. Compound datatype fields and enumeration datatype elements are stored in no particular order with index values of 0 through N-1, where N is the value returned by H5Tget_nmembers().
The HDF5 library allocates a buffer to receive the name of the field. The caller must subsequently free the buffer with H5free_memory().
int H5Tget_nmembers | ( | hid_t | type_id | ) |
Retrieves the number of elements in a compound or enumeration datatype.
[in] | type_id | Datatype identifier |
H5Tget_nmembers() retrieves the number of fields in a compound datatype or the number of members of an enumeration datatype.