H5Apublic.h File Reference

Data Structures
struct	H5A_info_t

Typedefs
typedef herr_t(*	H5A_operator2_t) (hid_t location_id, const char *attr_name, const H5A_info_t *ainfo, void *op_data)
typedef herr_t(*	H5A_operator1_t) (hid_t location_id, const char *attr_name, void *operator_data)

Functions
H5_DLL hid_t	H5Acreate2 (hid_t loc_id, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id)
H5_DLL hid_t	H5Acreate_by_name (hid_t loc_id, const char *obj_name, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id, hid_t lapl_id)
H5_DLL hid_t	H5Aopen (hid_t obj_id, const char *attr_name, hid_t aapl_id)
H5_DLL hid_t	H5Aopen_by_name (hid_t loc_id, const char *obj_name, const char *attr_name, hid_t aapl_id, hid_t lapl_id)
H5_DLL hid_t	H5Aopen_by_idx (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t aapl_id, hid_t lapl_id)
H5_DLL herr_t	H5Awrite (hid_t attr_id, hid_t type_id, const void *buf)
H5_DLL herr_t	H5Aread (hid_t attr_id, hid_t type_id, void *buf)
H5_DLL herr_t	H5Aclose (hid_t attr_id)
H5_DLL hid_t	H5Aget_space (hid_t attr_id)
H5_DLL hid_t	H5Aget_type (hid_t attr_id)
H5_DLL hid_t	H5Aget_create_plist (hid_t attr_id)
H5_DLL ssize_t	H5Aget_name (hid_t attr_id, size_t buf_size, char *buf)
H5_DLL ssize_t	H5Aget_name_by_idx (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, char *name, size_t size, hid_t lapl_id)
H5_DLL hsize_t	H5Aget_storage_size (hid_t attr_id)
H5_DLL herr_t	H5Aget_info (hid_t attr_id, H5A_info_t *ainfo)
H5_DLL herr_t	H5Aget_info_by_name (hid_t loc_id, const char *obj_name, const char *attr_name, H5A_info_t *ainfo, hid_t lapl_id)
H5_DLL herr_t	H5Aget_info_by_idx (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5A_info_t *ainfo, hid_t lapl_id)
H5_DLL herr_t	H5Arename (hid_t loc_id, const char *old_name, const char *new_name)
H5_DLL herr_t	H5Arename_by_name (hid_t loc_id, const char *obj_name, const char *old_attr_name, const char *new_attr_name, hid_t lapl_id)
H5_DLL herr_t	H5Aiterate2 (hid_t loc_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx, H5A_operator2_t op, void *op_data)
H5_DLL herr_t	H5Aiterate_by_name (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx, H5A_operator2_t op, void *op_data, hid_t lapd_id)
H5_DLL herr_t	H5Adelete (hid_t loc_id, const char *name)
H5_DLL herr_t	H5Adelete_by_name (hid_t loc_id, const char *obj_name, const char *attr_name, hid_t lapl_id)
H5_DLL herr_t	H5Adelete_by_idx (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id)
H5_DLL htri_t	H5Aexists (hid_t obj_id, const char *attr_name)
H5_DLL htri_t	H5Aexists_by_name (hid_t obj_id, const char *obj_name, const char *attr_name, hid_t lapl_id)
H5_DLL hid_t	H5Acreate1 (hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t acpl_id)
H5_DLL hid_t	H5Aopen_name (hid_t loc_id, const char *name)
H5_DLL hid_t	H5Aopen_idx (hid_t loc_id, unsigned idx)
H5_DLL int	H5Aget_num_attrs (hid_t loc_id)
H5_DLL herr_t	H5Aiterate1 (hid_t loc_id, unsigned *attr_num, H5A_operator1_t op, void *op_data)

Typedef Documentation

H5A_operator1_t

typedef herr_t(* H5A_operator1_t) (hid_t location_id, const char *attr_name, void *operator_data)

H5A_operator2_t

typedef herr_t(* H5A_operator2_t) (hid_t location_id, const char *attr_name, const H5A_info_t *ainfo, void *op_data)

Function Documentation

H5Aclose()

H5_DLL herr_t H5Aclose

(

hid_t

attr_id

)

References FAIL, H5I_ATTR, H5I_dec_app_ref(), H5I_object_verify(), NULL, and ret_value.

H5Acreate1()

H5_DLL hid_t H5Acreate1	(	hid_t	loc_id,
		const char *	name,
		hid_t	type_id,
		hid_t	space_id,
		hid_t	acpl_id
	)

References H5VL_object_t::connector, H5CX_set_loc(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5VL_attr_close(), H5VL_attr_create(), H5VL_OBJECT_BY_SELF, H5VL_register(), H5VL_vol_object(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Acreate2()

H5_DLL hid_t H5Acreate2	(	hid_t	loc_id,
		const char *	attr_name,
		hid_t	type_id,
		hid_t	space_id,
		hid_t	acpl_id,
		hid_t	aapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5P_CLS_AACC, H5VL_attr_close(), H5VL_attr_create(), H5VL_OBJECT_BY_SELF, H5VL_register(), H5VL_vol_object(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Acreate_by_name()

H5_DLL hid_t H5Acreate_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		const char *	attr_name,
		hid_t	type_id,
		hid_t	space_id,
		hid_t	acpl_id,
		hid_t	aapl_id,
		hid_t	lapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5P_CLS_AACC, H5P_CLS_LACC, H5VL_attr_close(), H5VL_attr_create(), H5VL_OBJECT_BY_NAME, H5VL_register(), H5VL_vol_object(), 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.

H5Adelete()

H5_DLL herr_t H5Adelete	(	hid_t	loc_id,
		const char *	name
	)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5VL_ATTR_DELETE, H5VL_attr_specific(), H5VL_OBJECT_BY_SELF, H5VL_vol_object(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Adelete_by_idx()

H5_DLL herr_t H5Adelete_by_idx	(	hid_t	loc_id,
		const char *	obj_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		hid_t	lapl_id
	)

References FAIL, H5_INDEX_N, H5_ITER_N, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_ATTR_DELETE, H5VL_attr_specific(), H5VL_OBJECT_BY_IDX, H5VL_vol_object(), H5VL_loc_by_idx::idx_type, H5VL_loc_by_idx::lapl_id, H5VL_loc_params_t::loc_by_idx, H5VL_loc_params_t::loc_data, n, H5VL_loc_by_idx::n, H5VL_loc_by_idx::name, NULL, H5VL_loc_params_t::obj_type, H5VL_loc_by_idx::order, ret_value, and H5VL_loc_params_t::type.

H5Adelete_by_name()

H5_DLL herr_t H5Adelete_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		const char *	attr_name,
		hid_t	lapl_id
	)

References FAIL, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_ATTR_DELETE, H5VL_attr_specific(), H5VL_OBJECT_BY_NAME, H5VL_vol_object(), 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.

H5Aexists()

H5_DLL htri_t H5Aexists	(	hid_t	obj_id,
		const char *	attr_name
	)

References FAIL, H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5VL_ATTR_EXISTS, H5VL_attr_specific(), H5VL_OBJECT_BY_SELF, H5VL_vol_object(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aexists_by_name()

H5_DLL htri_t H5Aexists_by_name	(	hid_t	obj_id,
		const char *	obj_name,
		const char *	attr_name,
		hid_t	lapl_id
	)

References FAIL, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_ATTR_EXISTS, H5VL_attr_specific(), H5VL_OBJECT_BY_NAME, H5VL_vol_object(), 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.

H5Aget_create_plist()

H5_DLL hid_t H5Aget_create_plist

(

hid_t

attr_id

)

References H5I_ATTR, H5I_object_verify(), H5P_LST_ATTRIBUTE_CREATE_ID_g, H5VL_attr_get(), H5VL_ATTR_GET_ACPL, HDassert(), NULL, and ret_value.

H5Aget_info()

H5_DLL herr_t H5Aget_info	(	hid_t	attr_id,
		H5A_info_t *	ainfo
	)

References FAIL, H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5I_object_verify(), H5VL_attr_get(), H5VL_ATTR_GET_INFO, H5VL_OBJECT_BY_SELF, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aget_info_by_idx()

H5_DLL herr_t H5Aget_info_by_idx	(	hid_t	loc_id,
		const char *	obj_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		H5A_info_t *	ainfo,
		hid_t	lapl_id
	)

References FAIL, H5_INDEX_N, H5_ITER_N, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_attr_get(), H5VL_ATTR_GET_INFO, H5VL_OBJECT_BY_IDX, H5VL_vol_object(), H5VL_loc_by_idx::idx_type, H5VL_loc_by_idx::lapl_id, H5VL_loc_params_t::loc_by_idx, H5VL_loc_params_t::loc_data, n, H5VL_loc_by_idx::n, H5VL_loc_by_idx::name, NULL, H5VL_loc_params_t::obj_type, H5VL_loc_by_idx::order, ret_value, and H5VL_loc_params_t::type.

H5Aget_info_by_name()

H5_DLL herr_t H5Aget_info_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		const char *	attr_name,
		H5A_info_t *	ainfo,
		hid_t	lapl_id
	)

References FAIL, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_attr_get(), H5VL_ATTR_GET_INFO, H5VL_OBJECT_BY_NAME, H5VL_vol_object(), 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.

H5Aget_name()

H5_DLL ssize_t H5Aget_name	(	hid_t	attr_id,
		size_t	buf_size,
		char *	buf
	)

References H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5I_object_verify(), H5VL_attr_get(), H5VL_ATTR_GET_NAME, H5VL_OBJECT_BY_SELF, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aget_name_by_idx()

H5_DLL ssize_t H5Aget_name_by_idx	(	hid_t	loc_id,
		const char *	obj_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		char *	name,
		size_t	size,
		hid_t	lapl_id
	)

References FAIL, H5_INDEX_N, H5_ITER_N, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_attr_get(), H5VL_ATTR_GET_NAME, H5VL_OBJECT_BY_IDX, H5VL_vol_object(), H5VL_loc_by_idx::idx_type, H5VL_loc_by_idx::lapl_id, H5VL_loc_params_t::loc_by_idx, H5VL_loc_params_t::loc_data, n, H5VL_loc_by_idx::n, H5VL_loc_by_idx::name, name, NULL, H5VL_loc_params_t::obj_type, H5VL_loc_by_idx::order, ret_value, size, and H5VL_loc_params_t::type.

H5Aget_num_attrs()

H5_DLL int H5Aget_num_attrs

(

hid_t

loc_id

)

References H5I_get_type(), H5VL_OBJECT_BY_SELF, H5VL_object_get(), H5VL_OBJECT_GET_INFO, H5VL_vol_object(), NULL, H5O_info2_t::num_attrs, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aget_space()

H5_DLL hid_t H5Aget_space

(

hid_t

attr_id

)

References H5I_ATTR, H5I_object_verify(), H5VL_attr_get(), H5VL_ATTR_GET_SPACE, NULL, and ret_value.

H5Aget_storage_size()

H5_DLL hsize_t H5Aget_storage_size

(

hid_t

attr_id

)

References H5I_ATTR, H5I_object_verify(), H5VL_attr_get(), H5VL_ATTR_GET_STORAGE_SIZE, NULL, and ret_value.

H5Aget_type()

H5_DLL hid_t H5Aget_type

(

hid_t

attr_id

)

References H5I_ATTR, H5I_object_verify(), H5VL_attr_get(), H5VL_ATTR_GET_TYPE, NULL, and ret_value.

H5Aiterate1()

H5_DLL herr_t H5Aiterate1	(	hid_t	loc_id,
		unsigned *	attr_num,
		H5A_operator1_t	op,
		void *	op_data
	)

References H5I_ATTR, H5I_get_type(), H5VL_attr_optional(), H5VL_vol_object(), NULL, and ret_value.

H5Aiterate2()

H5_DLL herr_t H5Aiterate2	(	hid_t	loc_id,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t *	idx,
		H5A_operator2_t	op,
		void *	op_data
	)

References FAIL, H5_INDEX_N, H5_ITER_N, H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5VL_ATTR_ITER, H5VL_attr_specific(), H5VL_OBJECT_BY_SELF, H5VL_vol_object(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aiterate_by_name()

H5_DLL herr_t H5Aiterate_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t *	idx,
		H5A_operator2_t	op,
		void *	op_data,
		hid_t	lapd_id
	)

References FAIL, H5_INDEX_N, H5_ITER_N, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_ATTR_ITER, H5VL_attr_specific(), H5VL_OBJECT_BY_NAME, H5VL_vol_object(), 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.

H5Aopen()

H5_DLL hid_t H5Aopen	(	hid_t	obj_id,
		const char *	attr_name,
		hid_t	aapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5P_CLS_AACC, H5VL_attr_close(), H5VL_attr_open(), H5VL_OBJECT_BY_SELF, H5VL_register(), H5VL_vol_object(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aopen_by_idx()

H5_DLL hid_t H5Aopen_by_idx	(	hid_t	loc_id,
		const char *	obj_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		hid_t	aapl_id,
		hid_t	lapl_id
	)

References H5VL_object_t::connector, H5_INDEX_N, H5_ITER_N, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5P_CLS_AACC, H5P_CLS_LACC, H5VL_attr_close(), H5VL_attr_open(), H5VL_OBJECT_BY_IDX, H5VL_register(), H5VL_vol_object(), H5VL_loc_by_idx::idx_type, H5VL_loc_by_idx::lapl_id, H5VL_loc_params_t::loc_by_idx, H5VL_loc_params_t::loc_data, n, H5VL_loc_by_idx::n, H5VL_loc_by_idx::name, NULL, H5VL_loc_params_t::obj_type, H5VL_loc_by_idx::order, ret_value, and H5VL_loc_params_t::type.

H5Aopen_by_name()

H5_DLL hid_t H5Aopen_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		const char *	attr_name,
		hid_t	aapl_id,
		hid_t	lapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5P_CLS_AACC, H5P_CLS_LACC, H5VL_attr_close(), H5VL_attr_open(), H5VL_OBJECT_BY_NAME, H5VL_register(), H5VL_vol_object(), 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.

H5Aopen_idx()

H5_DLL hid_t H5Aopen_idx	(	hid_t	loc_id,
		unsigned	idx
	)

References H5VL_object_t::connector, H5_INDEX_CRT_ORDER, H5_ITER_INC, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5VL_attr_close(), H5VL_attr_open(), H5VL_OBJECT_BY_IDX, H5VL_register(), H5VL_vol_object(), H5VL_loc_by_idx::idx_type, H5VL_loc_by_idx::lapl_id, H5VL_loc_params_t::loc_by_idx, H5VL_loc_params_t::loc_data, H5VL_loc_by_idx::n, H5VL_loc_by_idx::name, NULL, H5VL_loc_params_t::obj_type, H5VL_loc_by_idx::order, ret_value, and H5VL_loc_params_t::type.

H5Aopen_name()

H5_DLL hid_t H5Aopen_name	(	hid_t	loc_id,
		const char *	name
	)

References H5VL_object_t::connector, H5E_BADVALUE, H5E_CANTREGISTER, H5I_ATTR, H5I_get_type(), H5VL_attr_close(), H5VL_attr_open(), H5VL_OBJECT_BY_SELF, H5VL_register(), H5VL_vol_object(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Aread()

H5_DLL herr_t H5Aread	(	hid_t	attr_id,
		hid_t	type_id,
		void *	buf
	)

References FAIL, H5E_BADVALUE, H5I_ATTR, H5I_DATATYPE, H5I_get_type(), H5I_object_verify(), H5VL_attr_read(), NULL, and ret_value.

H5Arename()

H5_DLL herr_t H5Arename	(	hid_t	loc_id,
		const char *	old_name,
		const char *	new_name
	)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5VL_ATTR_RENAME, H5VL_attr_specific(), H5VL_OBJECT_BY_SELF, H5VL_vol_object(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Arename_by_name()

H5_DLL herr_t H5Arename_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		const char *	old_attr_name,
		const char *	new_attr_name,
		hid_t	lapl_id
	)

References FAIL, H5CX_set_apl(), H5E_BADVALUE, H5I_ATTR, H5I_get_type(), H5P_CLS_LACC, H5VL_ATTR_RENAME, H5VL_attr_specific(), H5VL_OBJECT_BY_NAME, H5VL_vol_object(), 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.

H5Awrite()

H5_DLL herr_t H5Awrite	(	hid_t	attr_id,
		hid_t	type_id,
		const void *	buf
	)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_ATTR, H5I_DATATYPE, H5I_get_type(), H5I_object_verify(), H5VL_attr_write(), NULL, and ret_value.