H5Mpublic.h File Reference

Typedefs
typedef enum H5VL_map_get_t	H5VL_map_get_t
typedef enum H5VL_map_specific_t	H5VL_map_specific_t
typedef herr_t(*	H5M_iterate_t) (hid_t map_id, const void *key, void *op_data)

Enumerations
enum	H5VL_map_get_t {   H5VL_MAP_GET_MAPL, H5VL_MAP_GET_MCPL, H5VL_MAP_GET_KEY_TYPE, H5VL_MAP_GET_VAL_TYPE,   H5VL_MAP_GET_COUNT }
enum	H5VL_map_specific_t { H5VL_MAP_ITER, H5VL_MAP_DELETE }

Functions
H5_DLL hid_t	H5Mcreate (hid_t loc_id, const char *name, hid_t key_type_id, hid_t val_type_id, hid_t lcpl_id, hid_t mcpl_id, hid_t mapl_id)
H5_DLL hid_t	H5Mcreate_anon (hid_t loc_id, hid_t key_type_id, hid_t val_type_id, hid_t mcpl_id, hid_t mapl_id)
H5_DLL hid_t	H5Mopen (hid_t loc_id, const char *name, hid_t mapl_id)
H5_DLL herr_t	H5Mclose (hid_t map_id)
H5_DLL hid_t	H5Mget_key_type (hid_t map_id)
H5_DLL hid_t	H5Mget_val_type (hid_t map_id)
H5_DLL hid_t	H5Mget_create_plist (hid_t map_id)
H5_DLL hid_t	H5Mget_access_plist (hid_t map_id)
H5_DLL herr_t	H5Mget_count (hid_t map_id, hsize_t *count, hid_t dxpl_id)
H5_DLL herr_t	H5Mput (hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, const void *value, hid_t dxpl_id)
H5_DLL herr_t	H5Mget (hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, void *value, hid_t dxpl_id)
H5_DLL herr_t	H5Mexists (hid_t map_id, hid_t key_mem_type_id, const void *key, hbool_t *exists, hid_t dxpl_id)
H5_DLL herr_t	H5Miterate (hid_t map_id, hsize_t *idx, hid_t key_mem_type_id, H5M_iterate_t op, void *op_data, hid_t dxpl_id)
H5_DLL herr_t	H5Miterate_by_name (hid_t loc_id, const char *map_name, hsize_t *idx, hid_t key_mem_type_id, H5M_iterate_t op, void *op_data, hid_t dxpl_id, hid_t lapl_id)
H5_DLL herr_t	H5Mdelete (hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t dxpl_id)

Typedef Documentation

H5M_iterate_t

typedef herr_t(* H5M_iterate_t) (hid_t map_id, const void *key, void *op_data)

H5VL_map_get_t

typedef enum H5VL_map_get_t H5VL_map_get_t

H5VL_map_specific_t

typedef enum H5VL_map_specific_t H5VL_map_specific_t

Enumeration Type Documentation

H5VL_map_get_t

enum H5VL_map_get_t

Enumerator
H5VL_MAP_GET_MAPL
H5VL_MAP_GET_MCPL
H5VL_MAP_GET_KEY_TYPE
H5VL_MAP_GET_VAL_TYPE
H5VL_MAP_GET_COUNT

H5VL_map_specific_t

enum H5VL_map_specific_t

Enumerator
H5VL_MAP_ITER
H5VL_MAP_DELETE

Function Documentation

H5Mclose()

H5_DLL herr_t H5Mclose

(

hid_t

map_id

)

References FAIL, H5I_dec_app_ref_always_close(), H5I_get_type(), H5I_MAP, and ret_value.

H5Mcreate()

H5_DLL hid_t H5Mcreate	(	hid_t	loc_id,
		const char *	name,
		hid_t	key_type_id,
		hid_t	val_type_id,
		hid_t	lcpl_id,
		hid_t	mcpl_id,
		hid_t	mapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_get_type(), H5I_MAP, H5I_object(), H5P_CLS_MACC, H5P_isa_class(), H5VL_OBJECT_BY_SELF, H5VL_optional(), H5VL_register(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Mcreate_anon()

H5_DLL hid_t H5Mcreate_anon	(	hid_t	loc_id,
		hid_t	key_type_id,
		hid_t	val_type_id,
		hid_t	mcpl_id,
		hid_t	mapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_CANTINIT, H5E_CANTREGISTER, H5I_get_type(), H5I_MAP, H5I_object(), H5P_CLS_MACC, H5P_isa_class(), H5VL_OBJECT_BY_SELF, H5VL_optional(), H5VL_register(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Mdelete()

H5_DLL herr_t H5Mdelete	(	hid_t	map_id,
		hid_t	key_mem_type_id,
		const void *	key,
		hid_t	dxpl_id
	)

References FAIL, H5CX_set_dxpl(), H5E_BADVALUE, H5I_get_type(), H5I_MAP, H5I_object_verify(), H5P_isa_class(), H5VL_MAP_DELETE, H5VL_OBJECT_BY_SELF, H5VL_optional(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Mexists()

H5_DLL herr_t H5Mexists	(	hid_t	map_id,
		hid_t	key_mem_type_id,
		const void *	key,
		hbool_t *	exists,
		hid_t	dxpl_id
	)

References FAIL, H5CX_set_dxpl(), H5E_BADVALUE, H5I_MAP, H5I_object_verify(), H5P_isa_class(), H5VL_optional(), NULL, and ret_value.

H5Mget()

H5_DLL herr_t H5Mget	(	hid_t	map_id,
		hid_t	key_mem_type_id,
		const void *	key,
		hid_t	val_mem_type_id,
		void *	value,
		hid_t	dxpl_id
	)

References FAIL, H5CX_set_dxpl(), H5E_BADVALUE, H5I_MAP, H5I_object_verify(), H5P_isa_class(), H5VL_optional(), NULL, and ret_value.

H5Mget_access_plist()

H5_DLL hid_t H5Mget_access_plist

(

hid_t

map_id

)

References H5I_MAP, H5I_object_verify(), H5VL_MAP_GET_MAPL, H5VL_optional(), NULL, and ret_value.

H5Mget_count()

H5_DLL herr_t H5Mget_count	(	hid_t	map_id,
		hsize_t *	count,
		hid_t	dxpl_id
	)

References FAIL, H5CX_set_dxpl(), H5I_MAP, H5I_object_verify(), H5P_isa_class(), H5VL_MAP_GET_COUNT, H5VL_optional(), NULL, and ret_value.

H5Mget_create_plist()

H5_DLL hid_t H5Mget_create_plist

(

hid_t

map_id

)

References H5I_MAP, H5I_object_verify(), H5VL_MAP_GET_MCPL, H5VL_optional(), NULL, and ret_value.

H5Mget_key_type()

H5_DLL hid_t H5Mget_key_type

(

hid_t

map_id

)

References H5I_MAP, H5I_object_verify(), H5VL_MAP_GET_KEY_TYPE, H5VL_optional(), NULL, and ret_value.

H5Mget_val_type()

H5_DLL hid_t H5Mget_val_type

(

hid_t

map_id

)

References H5I_MAP, H5I_object_verify(), H5VL_MAP_GET_VAL_TYPE, H5VL_optional(), NULL, and ret_value.

H5Miterate()

H5_DLL herr_t H5Miterate	(	hid_t	map_id,
		hsize_t *	idx,
		hid_t	key_mem_type_id,
		H5M_iterate_t	op,
		void *	op_data,
		hid_t	dxpl_id
	)

References FAIL, H5CX_set_dxpl(), H5E_BADVALUE, H5I_get_type(), H5I_MAP, H5I_object_verify(), H5P_isa_class(), H5VL_MAP_ITER, H5VL_OBJECT_BY_SELF, H5VL_optional(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Miterate_by_name()

H5_DLL herr_t H5Miterate_by_name	(	hid_t	loc_id,
		const char *	map_name,
		hsize_t *	idx,
		hid_t	key_mem_type_id,
		H5M_iterate_t	op,
		void *	op_data,
		hid_t	dxpl_id,
		hid_t	lapl_id
	)

References FAIL, H5CX_set_dxpl(), H5E_BADVALUE, H5I_get_type(), H5I_object(), H5P_isa_class(), H5VL_MAP_ITER, H5VL_OBJECT_BY_NAME, H5VL_optional(), H5VL_loc_by_name::lapl_id, H5VL_loc_params_t::loc_by_name, H5VL_loc_params_t::loc_data, H5VL_loc_by_name::name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Mopen()

H5_DLL hid_t H5Mopen	(	hid_t	loc_id,
		const char *	name,
		hid_t	mapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_get_type(), H5I_MAP, H5I_object(), H5P_CLS_MACC, H5VL_OBJECT_BY_SELF, H5VL_optional(), H5VL_register(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Mput()

H5_DLL herr_t H5Mput	(	hid_t	map_id,
		hid_t	key_mem_type_id,
		const void *	key,
		hid_t	val_mem_type_id,
		const void *	value,
		hid_t	dxpl_id
	)

References FAIL, H5CX_set_dxpl(), H5E_BADVALUE, H5I_MAP, H5I_object_verify(), H5P_isa_class(), H5VL_optional(), NULL, and ret_value.