HDF5  1.12.0
H5Ipublic.h File Reference

Typedefs

typedef enum H5I_type_t H5I_type_t
 
typedef int64_t hid_t
 
typedef herr_t(* H5I_free_t) (void *)
 
typedef int(* H5I_search_func_t) (void *obj, hid_t id, void *key)
 
typedef herr_t(* H5I_iterate_func_t) (hid_t id, void *udata)
 

Enumerations

enum  H5I_type_t {
  H5I_UNINIT = (-2), H5I_BADID = (-1), H5I_FILE = 1, H5I_GROUP,
  H5I_DATATYPE, H5I_DATASPACE, H5I_DATASET, H5I_MAP,
  H5I_ATTR, H5I_VFL, H5I_VOL, H5I_GENPROP_CLS,
  H5I_GENPROP_LST, H5I_ERROR_CLASS, H5I_ERROR_MSG, H5I_ERROR_STACK,
  H5I_SPACE_SEL_ITER, H5I_NTYPES
}
 

Functions

H5_DLL hid_t H5Iregister (H5I_type_t type, const void *object)
 
H5_DLL void * H5Iobject_verify (hid_t id, H5I_type_t id_type)
 
H5_DLL void * H5Iremove_verify (hid_t id, H5I_type_t id_type)
 
H5_DLL H5I_type_t H5Iget_type (hid_t id)
 
H5_DLL hid_t H5Iget_file_id (hid_t id)
 
H5_DLL ssize_t H5Iget_name (hid_t id, char *name, size_t size)
 
H5_DLL int H5Iinc_ref (hid_t id)
 
H5_DLL int H5Idec_ref (hid_t id)
 
H5_DLL int H5Iget_ref (hid_t id)
 
H5_DLL H5I_type_t H5Iregister_type (size_t hash_size, unsigned reserved, H5I_free_t free_func)
 
H5_DLL herr_t H5Iclear_type (H5I_type_t type, hbool_t force)
 
H5_DLL herr_t H5Idestroy_type (H5I_type_t type)
 
H5_DLL int H5Iinc_type_ref (H5I_type_t type)
 
H5_DLL int H5Idec_type_ref (H5I_type_t type)
 
H5_DLL int H5Iget_type_ref (H5I_type_t type)
 
H5_DLL void * H5Isearch (H5I_type_t type, H5I_search_func_t func, void *key)
 
H5_DLL herr_t H5Iiterate (H5I_type_t type, H5I_iterate_func_t op, void *op_data)
 
H5_DLL herr_t H5Inmembers (H5I_type_t type, hsize_t *num_members)
 
H5_DLL htri_t H5Itype_exists (H5I_type_t type)
 
H5_DLL htri_t H5Iis_valid (hid_t id)
 

Typedef Documentation

◆ H5I_free_t

typedef herr_t(* H5I_free_t) (void *)

◆ H5I_iterate_func_t

typedef herr_t(* H5I_iterate_func_t) (hid_t id, void *udata)

◆ H5I_search_func_t

typedef int(* H5I_search_func_t) (void *obj, hid_t id, void *key)

◆ H5I_type_t

typedef enum H5I_type_t H5I_type_t

◆ hid_t

typedef int64_t hid_t

Enumeration Type Documentation

◆ H5I_type_t

enum H5I_type_t
Enumerator
H5I_UNINIT 
H5I_BADID 
H5I_FILE 
H5I_GROUP 
H5I_DATATYPE 
H5I_DATASPACE 
H5I_DATASET 
H5I_MAP 
H5I_ATTR 
H5I_VFL 
H5I_VOL 
H5I_GENPROP_CLS 
H5I_GENPROP_LST 
H5I_ERROR_CLASS 
H5I_ERROR_MSG 
H5I_ERROR_STACK 
H5I_SPACE_SEL_ITER 
H5I_NTYPES 

Function Documentation

◆ H5Iclear_type()

H5_DLL herr_t H5Iclear_type ( H5I_type_t  type,
hbool_t  force 
)

References FAIL, H5I_clear_type(), ret_value, and type.

◆ H5Idec_ref()

H5_DLL int H5Idec_ref ( hid_t  id)

References H5I_dec_app_ref(), and ret_value.

◆ H5Idec_type_ref()

H5_DLL int H5Idec_type_ref ( H5I_type_t  type)

References H5I_dec_type_ref(), ret_value, and type.

◆ H5Idestroy_type()

H5_DLL herr_t H5Idestroy_type ( H5I_type_t  type)

References FAIL, ret_value, and type.

◆ H5Iget_file_id()

◆ H5Iget_name()

◆ H5Iget_ref()

H5_DLL int H5Iget_ref ( hid_t  id)

References H5I_get_ref(), and ret_value.

◆ H5Iget_type()

◆ H5Iget_type_ref()

H5_DLL int H5Iget_type_ref ( H5I_type_t  type)

References ret_value, and type.

◆ H5Iinc_ref()

H5_DLL int H5Iinc_ref ( hid_t  id)

References H5I_inc_ref(), and ret_value.

◆ H5Iinc_type_ref()

H5_DLL int H5Iinc_type_ref ( H5I_type_t  type)

References ret_value, and type.

◆ H5Iis_valid()

H5_DLL htri_t H5Iis_valid ( hid_t  id)

References FAIL, NULL, and ret_value.

◆ H5Iiterate()

H5_DLL herr_t H5Iiterate ( H5I_type_t  type,
H5I_iterate_func_t  op,
void *  op_data 
)

◆ H5Inmembers()

H5_DLL herr_t H5Inmembers ( H5I_type_t  type,
hsize_t *  num_members 
)

References FAIL, H5I_BADID, ret_value, and type.

◆ H5Iobject_verify()

H5_DLL void* H5Iobject_verify ( hid_t  id,
H5I_type_t  id_type 
)

References NULL, and ret_value.

◆ H5Iregister()

H5_DLL hid_t H5Iregister ( H5I_type_t  type,
const void *  object 
)

References FAIL, H5I_register(), ret_value, and type.

◆ H5Iregister_type()

H5_DLL H5I_type_t H5Iregister_type ( size_t  hash_size,
unsigned  reserved,
H5I_free_t  free_func 
)

References H5I_BADID, NULL, and ret_value.

◆ H5Iremove_verify()

H5_DLL void* H5Iremove_verify ( hid_t  id,
H5I_type_t  id_type 
)

References NULL, and ret_value.

◆ H5Isearch()

H5_DLL void* H5Isearch ( H5I_type_t  type,
H5I_search_func_t  func,
void *  key 
)

◆ H5Itype_exists()

H5_DLL htri_t H5Itype_exists ( H5I_type_t  type)

References FAIL, H5I_BADID, ret_value, and type.