Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5  1.15.0
API Reference
 
Loading...
Searching...
No Matches
H5LTpublic.h File Reference

Macros

#define H5LT_FILE_IMAGE_OPEN_RW   0x0001 /* Open image for read-write */
 
#define H5LT_FILE_IMAGE_DONT_COPY   0x0002 /* The HDF5 lib won't copy */
 
#define H5LT_FILE_IMAGE_DONT_RELEASE   0x0004 /* The HDF5 lib won't */
 
#define H5LT_FILE_IMAGE_ALL   0x0007
 

Enumerations

enum  H5LT_lang_t {
  H5LT_LANG_ERR = -1 , H5LT_DDL = 0 , H5LT_C = 1 , H5LT_FORTRAN = 2 ,
  H5LT_NO_LANG = 3
}
 

Functions

H5_HLDLL herr_t H5LTmake_dataset (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, hid_t type_id, const void *buffer)
 Creates and writes a dataset of a type type_id.
 
H5_HLDLL herr_t H5LTmake_dataset_char (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const char *buffer)
 Creates and writes a dataset.
 
H5_HLDLL herr_t H5LTmake_dataset_short (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const short *buffer)
 Creates and writes a dataset.
 
H5_HLDLL herr_t H5LTmake_dataset_int (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const int *buffer)
 Creates and writes a dataset.
 
H5_HLDLL herr_t H5LTmake_dataset_long (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const long *buffer)
 Creates and writes a dataset.
 
H5_HLDLL herr_t H5LTmake_dataset_float (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const float *buffer)
 Creates and writes a dataset.
 
H5_HLDLL herr_t H5LTmake_dataset_double (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const double *buffer)
 Creates and writes a dataset.
 
H5_HLDLL herr_t H5LTmake_dataset_string (hid_t loc_id, const char *dset_name, const char *buf)
 Creates and writes a dataset with string datatype.
 
H5_HLDLL herr_t H5LTread_dataset (hid_t loc_id, const char *dset_name, hid_t type_id, void *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_char (hid_t loc_id, const char *dset_name, char *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_short (hid_t loc_id, const char *dset_name, short *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_int (hid_t loc_id, const char *dset_name, int *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_long (hid_t loc_id, const char *dset_name, long *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_float (hid_t loc_id, const char *dset_name, float *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_double (hid_t loc_id, const char *dset_name, double *buffer)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTread_dataset_string (hid_t loc_id, const char *dset_name, char *buf)
 Reads a dataset from disk.
 
H5_HLDLL herr_t H5LTget_dataset_ndims (hid_t loc_id, const char *dset_name, int *rank)
 Gets the dimensionality of a dataset.
 
H5_HLDLL herr_t H5LTget_dataset_info (hid_t loc_id, const char *dset_name, hsize_t *dims, H5T_class_t *type_class, size_t *type_size)
 Retrieves information about a dataset.
 
H5_HLDLL herr_t H5LTfind_dataset (hid_t loc_id, const char *name)
 Determines whether a dataset exists.
 
H5_HLDLL herr_t H5LTset_attribute_string (hid_t loc_id, const char *obj_name, const char *attr_name, const char *attr_data)
 Creates and writes a string attribute.
 
H5_HLDLL herr_t H5LTset_attribute_char (hid_t loc_id, const char *obj_name, const char *attr_name, const char *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_uchar (hid_t loc_id, const char *obj_name, const char *attr_name, const unsigned char *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_short (hid_t loc_id, const char *obj_name, const char *attr_name, const short *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_ushort (hid_t loc_id, const char *obj_name, const char *attr_name, const unsigned short *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_int (hid_t loc_id, const char *obj_name, const char *attr_name, const int *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_uint (hid_t loc_id, const char *obj_name, const char *attr_name, const unsigned int *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_long (hid_t loc_id, const char *obj_name, const char *attr_name, const long *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_long_long (hid_t loc_id, const char *obj_name, const char *attr_name, const long long *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_ulong (hid_t loc_id, const char *obj_name, const char *attr_name, const unsigned long *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_ullong (hid_t loc_id, const char *obj_name, const char *attr_name, const unsigned long long *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_float (hid_t loc_id, const char *obj_name, const char *attr_name, const float *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTset_attribute_double (hid_t loc_id, const char *obj_name, const char *attr_name, const double *buffer, size_t size)
 Creates and writes an attribute.
 
H5_HLDLL herr_t H5LTget_attribute (hid_t loc_id, const char *obj_name, const char *attr_name, hid_t mem_type_id, void *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_string (hid_t loc_id, const char *obj_name, const char *attr_name, char *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_char (hid_t loc_id, const char *obj_name, const char *attr_name, char *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_uchar (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned char *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_short (hid_t loc_id, const char *obj_name, const char *attr_name, short *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_ushort (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned short *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_int (hid_t loc_id, const char *obj_name, const char *attr_name, int *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_uint (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned int *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_long (hid_t loc_id, const char *obj_name, const char *attr_name, long *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_long_long (hid_t loc_id, const char *obj_name, const char *attr_name, long long *data)
 Reads a long long attribute.
 
H5_HLDLL herr_t H5LTget_attribute_ulong (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned long *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_ullong (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned long long *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_float (hid_t loc_id, const char *obj_name, const char *attr_name, float *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_double (hid_t loc_id, const char *obj_name, const char *attr_name, double *data)
 Reads an attribute from disk.
 
H5_HLDLL herr_t H5LTget_attribute_ndims (hid_t loc_id, const char *obj_name, const char *attr_name, int *rank)
 Gets the dimensionality of an attribute.
 
H5_HLDLL herr_t H5LTget_attribute_info (hid_t loc_id, const char *obj_name, const char *attr_name, hsize_t *dims, H5T_class_t *type_class, size_t *type_size)
 Gets information about an attribute.
 
H5_HLDLL hid_t H5LTtext_to_dtype (const char *text, H5LT_lang_t lang_type)
 Creates an HDF5 datatype given a text description.
 
H5_HLDLL herr_t H5LTdtype_to_text (hid_t dtype, char *str, H5LT_lang_t lang_type, size_t *len)
 Creates a text description of an HDF5 datatype.
 
H5_HLDLL herr_t H5LTfind_attribute (hid_t loc_id, const char *name)
 Determines whether an attribute exists.
 
H5_HLDLL htri_t H5LTpath_valid (hid_t loc_id, const char *path, hbool_t check_object_valid)
 Determines whether an HDF5 path is valid and, optionally, whether the path resolves to an HDF5 object.
 
H5_HLDLL hid_t H5LTopen_file_image (void *buf_ptr, size_t buf_size, unsigned flags)
 Opens an HDF5 file image in memory.
 

Macro Definition Documentation

◆ H5LT_FILE_IMAGE_ALL

#define H5LT_FILE_IMAGE_ALL   0x0007

◆ H5LT_FILE_IMAGE_DONT_COPY

#define H5LT_FILE_IMAGE_DONT_COPY   0x0002 /* The HDF5 lib won't copy */

◆ H5LT_FILE_IMAGE_DONT_RELEASE

#define H5LT_FILE_IMAGE_DONT_RELEASE   0x0004 /* The HDF5 lib won't */

◆ H5LT_FILE_IMAGE_OPEN_RW

#define H5LT_FILE_IMAGE_OPEN_RW   0x0001 /* Open image for read-write */

Enumeration Type Documentation

◆ H5LT_lang_t

Enumerator
H5LT_LANG_ERR 
H5LT_DDL 
H5LT_C 
H5LT_FORTRAN 
H5LT_NO_LANG