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
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)
 
H5_HLDLL herr_t H5LTmake_dataset_char (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const char *buffer)
 
H5_HLDLL herr_t H5LTmake_dataset_short (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const short *buffer)
 
H5_HLDLL herr_t H5LTmake_dataset_int (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const int *buffer)
 
H5_HLDLL herr_t H5LTmake_dataset_long (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const long *buffer)
 
H5_HLDLL herr_t H5LTmake_dataset_float (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const float *buffer)
 
H5_HLDLL herr_t H5LTmake_dataset_double (hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, const double *buffer)
 
H5_HLDLL herr_t H5LTmake_dataset_string (hid_t loc_id, const char *dset_name, const char *buf)
 
H5_HLDLL herr_t H5LTread_dataset (hid_t loc_id, const char *dset_name, hid_t type_id, void *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_char (hid_t loc_id, const char *dset_name, char *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_short (hid_t loc_id, const char *dset_name, short *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_int (hid_t loc_id, const char *dset_name, int *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_long (hid_t loc_id, const char *dset_name, long *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_float (hid_t loc_id, const char *dset_name, float *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_double (hid_t loc_id, const char *dset_name, double *buffer)
 
H5_HLDLL herr_t H5LTread_dataset_string (hid_t loc_id, const char *dset_name, char *buf)
 
H5_HLDLL herr_t H5LTget_dataset_ndims (hid_t loc_id, const char *dset_name, int *rank)
 
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)
 
H5_HLDLL herr_t H5LTfind_dataset (hid_t loc_id, const char *name)
 
H5_HLDLL herr_t H5LTset_attribute_string (hid_t loc_id, const char *obj_name, const char *attr_name, const char *attr_data)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
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)
 
H5_HLDLL herr_t H5LTget_attribute_string (hid_t loc_id, const char *obj_name, const char *attr_name, char *data)
 
H5_HLDLL herr_t H5LTget_attribute_char (hid_t loc_id, const char *obj_name, const char *attr_name, char *data)
 
H5_HLDLL herr_t H5LTget_attribute_uchar (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned char *data)
 
H5_HLDLL herr_t H5LTget_attribute_short (hid_t loc_id, const char *obj_name, const char *attr_name, short *data)
 
H5_HLDLL herr_t H5LTget_attribute_ushort (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned short *data)
 
H5_HLDLL herr_t H5LTget_attribute_int (hid_t loc_id, const char *obj_name, const char *attr_name, int *data)
 
H5_HLDLL herr_t H5LTget_attribute_uint (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned int *data)
 
H5_HLDLL herr_t H5LTget_attribute_long (hid_t loc_id, const char *obj_name, const char *attr_name, long *data)
 
H5_HLDLL herr_t H5LTget_attribute_long_long (hid_t loc_id, const char *obj_name, const char *attr_name, long long *data)
 
H5_HLDLL herr_t H5LTget_attribute_ulong (hid_t loc_id, const char *obj_name, const char *attr_name, unsigned long *data)
 
H5_HLDLL herr_t H5LTget_attribute_float (hid_t loc_id, const char *obj_name, const char *attr_name, float *data)
 
H5_HLDLL herr_t H5LTget_attribute_double (hid_t loc_id, const char *obj_name, const char *attr_name, double *data)
 
H5_HLDLL herr_t H5LTget_attribute_ndims (hid_t loc_id, const char *obj_name, const char *attr_name, int *rank)
 
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)
 
H5_HLDLL hid_t H5LTtext_to_dtype (const char *text, H5LT_lang_t lang_type)
 
H5_HLDLL herr_t H5LTdtype_to_text (hid_t dtype, char *str, H5LT_lang_t lang_type, size_t *len)
 
H5_HLDLL herr_t H5LTfind_attribute (hid_t loc_id, const char *name)
 
H5_HLDLL htri_t H5LTpath_valid (hid_t loc_id, const char *path, hbool_t check_object_valid)
 
H5_HLDLL hid_t H5LTopen_file_image (void *buf_ptr, size_t buf_size, unsigned flags)
 

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 

Function Documentation

◆ H5LTdtype_to_text()

H5_HLDLL herr_t H5LTdtype_to_text ( hid_t  dtype,
char *  str,
H5LT_lang_t  lang_type,
size_t *  len 
)

◆ H5LTfind_attribute()

H5_HLDLL herr_t H5LTfind_attribute ( hid_t  loc_id,
const char *  name 
)

◆ H5LTfind_dataset()

H5_HLDLL herr_t H5LTfind_dataset ( hid_t  loc_id,
const char *  name 
)

◆ H5LTget_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 
)

◆ H5LTget_attribute_char()

H5_HLDLL herr_t H5LTget_attribute_char ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
char *  data 
)

◆ H5LTget_attribute_double()

H5_HLDLL herr_t H5LTget_attribute_double ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
double *  data 
)

◆ H5LTget_attribute_float()

H5_HLDLL herr_t H5LTget_attribute_float ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
float *  data 
)

◆ H5LTget_attribute_info()

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 
)

◆ H5LTget_attribute_int()

H5_HLDLL herr_t H5LTget_attribute_int ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
int *  data 
)

◆ H5LTget_attribute_long()

H5_HLDLL herr_t H5LTget_attribute_long ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
long *  data 
)

◆ H5LTget_attribute_long_long()

H5_HLDLL herr_t H5LTget_attribute_long_long ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
long long *  data 
)

◆ H5LTget_attribute_ndims()

H5_HLDLL herr_t H5LTget_attribute_ndims ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
int *  rank 
)

◆ H5LTget_attribute_short()

H5_HLDLL herr_t H5LTget_attribute_short ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
short *  data 
)

◆ H5LTget_attribute_string()

H5_HLDLL herr_t H5LTget_attribute_string ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
char *  data 
)

◆ H5LTget_attribute_uchar()

H5_HLDLL herr_t H5LTget_attribute_uchar ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
unsigned char *  data 
)

◆ H5LTget_attribute_uint()

H5_HLDLL herr_t H5LTget_attribute_uint ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
unsigned int *  data 
)

◆ H5LTget_attribute_ulong()

H5_HLDLL herr_t H5LTget_attribute_ulong ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
unsigned long *  data 
)

◆ H5LTget_attribute_ushort()

H5_HLDLL herr_t H5LTget_attribute_ushort ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
unsigned short *  data 
)

◆ H5LTget_dataset_info()

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 
)

◆ H5LTget_dataset_ndims()

H5_HLDLL herr_t H5LTget_dataset_ndims ( hid_t  loc_id,
const char *  dset_name,
int *  rank 
)

◆ H5LTmake_dataset()

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 
)

◆ H5LTmake_dataset_char()

H5_HLDLL herr_t H5LTmake_dataset_char ( hid_t  loc_id,
const char *  dset_name,
int  rank,
const hsize_t dims,
const char *  buffer 
)

◆ H5LTmake_dataset_double()

H5_HLDLL herr_t H5LTmake_dataset_double ( hid_t  loc_id,
const char *  dset_name,
int  rank,
const hsize_t dims,
const double *  buffer 
)

◆ H5LTmake_dataset_float()

H5_HLDLL herr_t H5LTmake_dataset_float ( hid_t  loc_id,
const char *  dset_name,
int  rank,
const hsize_t dims,
const float *  buffer 
)

◆ H5LTmake_dataset_int()

H5_HLDLL herr_t H5LTmake_dataset_int ( hid_t  loc_id,
const char *  dset_name,
int  rank,
const hsize_t dims,
const int *  buffer 
)

◆ H5LTmake_dataset_long()

H5_HLDLL herr_t H5LTmake_dataset_long ( hid_t  loc_id,
const char *  dset_name,
int  rank,
const hsize_t dims,
const long *  buffer 
)

◆ H5LTmake_dataset_short()

H5_HLDLL herr_t H5LTmake_dataset_short ( hid_t  loc_id,
const char *  dset_name,
int  rank,
const hsize_t dims,
const short *  buffer 
)

◆ H5LTmake_dataset_string()

H5_HLDLL herr_t H5LTmake_dataset_string ( hid_t  loc_id,
const char *  dset_name,
const char *  buf 
)

◆ H5LTopen_file_image()

H5_HLDLL hid_t H5LTopen_file_image ( void *  buf_ptr,
size_t  buf_size,
unsigned  flags 
)

◆ H5LTpath_valid()

H5_HLDLL htri_t H5LTpath_valid ( hid_t  loc_id,
const char *  path,
hbool_t  check_object_valid 
)

◆ H5LTread_dataset()

H5_HLDLL herr_t H5LTread_dataset ( hid_t  loc_id,
const char *  dset_name,
hid_t  type_id,
void *  buffer 
)

◆ H5LTread_dataset_char()

H5_HLDLL herr_t H5LTread_dataset_char ( hid_t  loc_id,
const char *  dset_name,
char *  buffer 
)

◆ H5LTread_dataset_double()

H5_HLDLL herr_t H5LTread_dataset_double ( hid_t  loc_id,
const char *  dset_name,
double *  buffer 
)

◆ H5LTread_dataset_float()

H5_HLDLL herr_t H5LTread_dataset_float ( hid_t  loc_id,
const char *  dset_name,
float *  buffer 
)

◆ H5LTread_dataset_int()

H5_HLDLL herr_t H5LTread_dataset_int ( hid_t  loc_id,
const char *  dset_name,
int *  buffer 
)

◆ H5LTread_dataset_long()

H5_HLDLL herr_t H5LTread_dataset_long ( hid_t  loc_id,
const char *  dset_name,
long *  buffer 
)

◆ H5LTread_dataset_short()

H5_HLDLL herr_t H5LTread_dataset_short ( hid_t  loc_id,
const char *  dset_name,
short *  buffer 
)

◆ H5LTread_dataset_string()

H5_HLDLL herr_t H5LTread_dataset_string ( hid_t  loc_id,
const char *  dset_name,
char *  buf 
)

◆ H5LTset_attribute_char()

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 
)

◆ H5LTset_attribute_double()

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 
)

◆ H5LTset_attribute_float()

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 
)

◆ H5LTset_attribute_int()

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 
)

◆ H5LTset_attribute_long()

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 
)

◆ H5LTset_attribute_long_long()

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 
)

◆ H5LTset_attribute_short()

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 
)

◆ H5LTset_attribute_string()

H5_HLDLL herr_t H5LTset_attribute_string ( hid_t  loc_id,
const char *  obj_name,
const char *  attr_name,
const char *  attr_data 
)

◆ H5LTset_attribute_uchar()

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 
)

◆ H5LTset_attribute_uint()

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 
)

◆ H5LTset_attribute_ulong()

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 
)

◆ H5LTset_attribute_ushort()

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 
)

◆ H5LTtext_to_dtype()

H5_HLDLL hid_t H5LTtext_to_dtype ( const char *  text,
H5LT_lang_t  lang_type 
)