H5Gpublic.h File Reference

Data Structures
struct	H5G_info_t
struct	H5G_stat_t

Typedefs
typedef enum H5G_storage_type_t	H5G_storage_type_t
typedef struct H5G_info_t	H5G_info_t
typedef enum H5G_obj_t	H5G_obj_t
typedef herr_t(*	H5G_iterate_t) (hid_t group, const char *name, void *op_data)
typedef struct H5G_stat_t	H5G_stat_t

Enumerations
enum	H5G_storage_type_t { H5G_STORAGE_TYPE_UNKNOWN = -1, H5G_STORAGE_TYPE_SYMBOL_TABLE, H5G_STORAGE_TYPE_COMPACT, H5G_STORAGE_TYPE_DENSE }
enum	H5G_obj_t {   H5G_UNKNOWN = -1, H5G_GROUP, H5G_DATASET, H5G_TYPE,   H5G_LINK, H5G_UDLINK, H5G_RESERVED_5, H5G_RESERVED_6,   H5G_RESERVED_7 }

Functions
H5_DLL hid_t	H5Gcreate2 (hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id)
H5_DLL hid_t	H5Gcreate_anon (hid_t loc_id, hid_t gcpl_id, hid_t gapl_id)
H5_DLL hid_t	H5Gopen2 (hid_t loc_id, const char *name, hid_t gapl_id)
H5_DLL hid_t	H5Gget_create_plist (hid_t group_id)
H5_DLL herr_t	H5Gget_info (hid_t loc_id, H5G_info_t *ginfo)
H5_DLL herr_t	H5Gget_info_by_name (hid_t loc_id, const char *name, H5G_info_t *ginfo, hid_t lapl_id)
H5_DLL herr_t	H5Gget_info_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo, hid_t lapl_id)
H5_DLL herr_t	H5Gclose (hid_t group_id)
H5_DLL herr_t	H5Gflush (hid_t group_id)
H5_DLL herr_t	H5Grefresh (hid_t group_id)
H5_DLL hid_t	H5Gcreate1 (hid_t loc_id, const char *name, size_t size_hint)
H5_DLL hid_t	H5Gopen1 (hid_t loc_id, const char *name)
H5_DLL herr_t	H5Glink (hid_t cur_loc_id, H5G_link_t type, const char *cur_name, const char *new_name)
H5_DLL herr_t	H5Glink2 (hid_t cur_loc_id, const char *cur_name, H5G_link_t type, hid_t new_loc_id, const char *new_name)
H5_DLL herr_t	H5Gmove (hid_t src_loc_id, const char *src_name, const char *dst_name)
H5_DLL herr_t	H5Gmove2 (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name)
H5_DLL herr_t	H5Gunlink (hid_t loc_id, const char *name)
H5_DLL herr_t	H5Gget_linkval (hid_t loc_id, const char *name, size_t size, char *buf)
H5_DLL herr_t	H5Gset_comment (hid_t loc_id, const char *name, const char *comment)
H5_DLL int	H5Gget_comment (hid_t loc_id, const char *name, size_t bufsize, char *buf)
H5_DLL herr_t	H5Giterate (hid_t loc_id, const char *name, int *idx, H5G_iterate_t op, void *op_data)
H5_DLL herr_t	H5Gget_num_objs (hid_t loc_id, hsize_t *num_objs)
H5_DLL herr_t	H5Gget_objinfo (hid_t loc_id, const char *name, hbool_t follow_link, H5G_stat_t *statbuf)
H5_DLL ssize_t	H5Gget_objname_by_idx (hid_t loc_id, hsize_t idx, char *name, size_t size)
H5_DLL H5G_obj_t	H5Gget_objtype_by_idx (hid_t loc_id, hsize_t idx)

Typedef Documentation

H5G_info_t

typedef struct H5G_info_t H5G_info_t

H5G_iterate_t

typedef herr_t(* H5G_iterate_t) (hid_t group, const char *name, void *op_data)

H5G_obj_t

typedef enum H5G_obj_t H5G_obj_t

H5G_stat_t

typedef struct H5G_stat_t H5G_stat_t

H5G_storage_type_t

typedef enum H5G_storage_type_t H5G_storage_type_t

Enumeration Type Documentation

H5G_obj_t

enum H5G_obj_t

Enumerator
H5G_UNKNOWN
H5G_GROUP
H5G_DATASET
H5G_TYPE
H5G_LINK
H5G_UDLINK
H5G_RESERVED_5
H5G_RESERVED_6
H5G_RESERVED_7

H5G_storage_type_t

enum H5G_storage_type_t

Enumerator
H5G_STORAGE_TYPE_UNKNOWN
H5G_STORAGE_TYPE_SYMBOL_TABLE
H5G_STORAGE_TYPE_COMPACT
H5G_STORAGE_TYPE_DENSE

Function Documentation

H5Gclose()

H5_DLL herr_t H5Gclose

(

hid_t

group_id

)

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

H5Gcreate1()

H5_DLL hid_t H5Gcreate1	(	hid_t	loc_id,
		const char *	name,
		size_t	size_hint
	)

References H5VL_object_t::connector, H5CX_set_loc(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_dec_ref(), H5I_get_type(), H5I_GROUP, H5I_object(), H5P_copy_plist(), H5P_get(), H5P_set(), H5VL_group_close(), H5VL_group_create(), H5VL_OBJECT_BY_SELF, H5VL_register(), H5O_ginfo_t::lheap_size_hint, name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gcreate2()

H5_DLL hid_t H5Gcreate2	(	hid_t	loc_id,
		const char *	name,
		hid_t	lcpl_id,
		hid_t	gcpl_id,
		hid_t	gapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5CX_set_lcpl(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_get_type(), H5I_GROUP, H5I_object(), H5P_CLS_GACC, H5P_isa_class(), H5VL_group_close(), H5VL_group_create(), H5VL_OBJECT_BY_SELF, H5VL_register(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gcreate_anon()

H5_DLL hid_t H5Gcreate_anon	(	hid_t	loc_id,
		hid_t	gcpl_id,
		hid_t	gapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_CANTINIT, H5E_CANTREGISTER, H5I_get_type(), H5I_GROUP, H5I_object(), H5P_CLS_GACC, H5P_isa_class(), H5VL_group_close(), H5VL_group_create(), H5VL_OBJECT_BY_SELF, H5VL_register(), NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gflush()

H5_DLL herr_t H5Gflush

(

hid_t

group_id

)

References FAIL, H5CX_set_loc(), H5I_GROUP, H5I_object_verify(), H5VL_GROUP_FLUSH, H5VL_group_specific(), NULL, and ret_value.

H5Gget_comment()

H5_DLL int H5Gget_comment	(	hid_t	loc_id,
		const char *	name,
		size_t	bufsize,
		char *	buf
	)

References H5CX_set_loc(), H5E_BADVALUE, H5I_get_type(), H5VL_OBJECT_BY_NAME, H5VL_object_optional(), 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, name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gget_create_plist()

H5_DLL hid_t H5Gget_create_plist

(

hid_t

group_id

)

References H5I_GROUP, H5I_object_verify(), H5VL_group_get(), H5VL_GROUP_GET_GCPL, NULL, and ret_value.

H5Gget_info()

H5_DLL herr_t H5Gget_info	(	hid_t	loc_id,
		H5G_info_t *	ginfo
	)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_get_type(), H5I_GROUP, H5I_object(), H5VL_group_get(), H5VL_GROUP_GET_INFO, H5VL_OBJECT_BY_SELF, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gget_info_by_idx()

H5_DLL herr_t H5Gget_info_by_idx	(	hid_t	loc_id,
		const char *	group_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		H5G_info_t *	ginfo,
		hid_t	lapl_id
	)

References FAIL, H5_INDEX_N, H5_ITER_N, H5CX_set_apl(), H5E_BADVALUE, H5I_get_type(), H5I_object(), H5P_CLS_LACC, H5VL_group_get(), H5VL_GROUP_GET_INFO, H5VL_OBJECT_BY_IDX, 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.

H5Gget_info_by_name()

H5_DLL herr_t H5Gget_info_by_name	(	hid_t	loc_id,
		const char *	name,
		H5G_info_t *	ginfo,
		hid_t	lapl_id
	)

References FAIL, H5CX_set_apl(), H5E_BADVALUE, H5I_get_type(), H5I_object(), H5P_CLS_LACC, H5VL_group_get(), H5VL_GROUP_GET_INFO, H5VL_OBJECT_BY_NAME, H5VL_loc_by_name::lapl_id, H5VL_loc_params_t::loc_by_name, H5VL_loc_params_t::loc_data, H5VL_loc_by_name::name, name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gget_linkval()

H5_DLL herr_t H5Gget_linkval	(	hid_t	loc_id,
		const char *	name,
		size_t	size,
		char *	buf
	)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_get_type(), H5I_object(), H5VL_link_get(), H5VL_LINK_GET_VAL, H5VL_OBJECT_BY_NAME, H5VL_loc_by_name::lapl_id, H5VL_loc_params_t::loc_by_name, H5VL_loc_params_t::loc_data, H5VL_loc_by_name::name, name, NULL, H5VL_loc_params_t::obj_type, ret_value, size, and H5VL_loc_params_t::type.

H5Gget_num_objs()

H5_DLL herr_t H5Gget_num_objs	(	hid_t	loc_id,
		hsize_t *	num_objs
	)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_get_type(), H5I_GROUP, H5I_object(), H5VL_group_get(), H5VL_GROUP_GET_INFO, H5VL_OBJECT_BY_SELF, H5G_info_t::nlinks, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gget_objinfo()

H5_DLL herr_t H5Gget_objinfo	(	hid_t	loc_id,
		const char *	name,
		hbool_t	follow_link,
		H5G_stat_t *	statbuf
	)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_get_type(), H5VL_group_optional(), 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, name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gget_objname_by_idx()

H5_DLL ssize_t H5Gget_objname_by_idx	(	hid_t	loc_id,
		hsize_t	idx,
		char *	name,
		size_t	size
	)

References FAIL, H5_INDEX_NAME, H5_ITER_INC, H5CX_set_loc(), H5I_get_type(), H5I_object(), H5VL_link_get(), H5VL_LINK_GET_NAME, H5VL_OBJECT_BY_IDX, 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, name, NULL, H5VL_loc_params_t::obj_type, H5VL_loc_by_idx::order, ret_value, size, and H5VL_loc_params_t::type.

H5Gget_objtype_by_idx()

H5_DLL H5G_obj_t H5Gget_objtype_by_idx	(	hid_t	loc_id,
		hsize_t	idx
	)

References H5_INDEX_NAME, H5_ITER_INC, H5G_map_obj_type(), H5G_UNKNOWN, H5I_get_type(), H5VL_OBJECT_BY_IDX, H5VL_object_get(), H5VL_OBJECT_GET_INFO, 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, H5O_info2_t::type, and H5VL_loc_params_t::type.

H5Giterate()

H5_DLL herr_t H5Giterate	(	hid_t	loc_id,
		const char *	name,
		int *	idx,
		H5G_iterate_t	op,
		void *	op_data
	)

References FAIL, H5E_BADVALUE, H5G_LINK_OP_OLD, H5I_get_type(), H5VL_group_optional(), 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, name, NULL, H5VL_loc_params_t::obj_type, H5G_link_iterate_t::op_func, H5G_link_iterate_t::op_old, H5G_link_iterate_t::op_type, ret_value, and H5VL_loc_params_t::type.

H5Glink()

H5_DLL herr_t H5Glink	(	hid_t	cur_loc_id,
		H5G_link_t	type,
		const char *	cur_name,
		const char *	new_name
	)

References H5VL_object_t::connector, H5VL_object_t::data, FAIL, H5CX_set_loc(), H5E_BADVALUE, H5E_CANTINIT, H5I_get_type(), H5I_object(), H5L_TYPE_HARD, H5L_TYPE_SOFT, H5VL_link_create(), H5VL_LINK_CREATE_HARD, H5VL_LINK_CREATE_SOFT, H5VL_OBJECT_BY_NAME, 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, H5VL_loc_params_t::type, and type.

H5Glink2()

H5_DLL herr_t H5Glink2	(	hid_t	cur_loc_id,
		const char *	cur_name,
		H5G_link_t	type,
		hid_t	new_loc_id,
		const char *	new_name
	)

References H5VL_object_t::data, FAIL, H5CX_set_loc(), H5E_BADVALUE, H5E_CANTINIT, H5I_get_type(), H5I_object(), H5L_TYPE_HARD, H5L_TYPE_SOFT, H5VL_link_create(), H5VL_LINK_CREATE_HARD, H5VL_LINK_CREATE_SOFT, H5VL_OBJECT_BY_NAME, 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, H5VL_loc_params_t::type, and type.

H5Gmove()

H5_DLL herr_t H5Gmove	(	hid_t	src_loc_id,
		const char *	src_name,
		const char *	dst_name
	)

References FAIL, H5CX_set_loc(), H5I_get_type(), H5I_object(), H5VL_link_move(), H5VL_OBJECT_BY_NAME, 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.

H5Gmove2()

H5_DLL herr_t H5Gmove2	(	hid_t	src_loc_id,
		const char *	src_name,
		hid_t	dst_loc_id,
		const char *	dst_name
	)

References FAIL, H5CX_set_loc(), H5I_get_type(), H5I_object(), H5VL_link_move(), H5VL_OBJECT_BY_NAME, 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.

H5Gopen1()

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

References H5VL_object_t::connector, H5E_BADVALUE, H5E_CANTREGISTER, H5I_get_type(), H5I_GROUP, H5I_object(), H5VL_group_close(), H5VL_group_open(), H5VL_OBJECT_BY_SELF, H5VL_register(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gopen2()

H5_DLL hid_t H5Gopen2	(	hid_t	loc_id,
		const char *	name,
		hid_t	gapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_get_type(), H5I_GROUP, H5I_object(), H5P_CLS_GACC, H5VL_group_close(), H5VL_group_open(), H5VL_OBJECT_BY_SELF, H5VL_register(), name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Grefresh()

H5_DLL herr_t H5Grefresh

(

hid_t

group_id

)

References FAIL, H5CX_set_loc(), H5I_GROUP, H5I_object_verify(), H5VL_GROUP_REFRESH, H5VL_group_specific(), NULL, and ret_value.

H5Gset_comment()

H5_DLL herr_t H5Gset_comment	(	hid_t	loc_id,
		const char *	name,
		const char *	comment
	)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_get_type(), H5VL_OBJECT_BY_NAME, H5VL_object_optional(), 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, name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.

H5Gunlink()

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

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_get_type(), H5I_object(), H5VL_LINK_DELETE, H5VL_link_specific(), H5VL_OBJECT_BY_NAME, H5VL_loc_by_name::lapl_id, H5VL_loc_params_t::loc_by_name, H5VL_loc_params_t::loc_data, H5VL_loc_by_name::name, name, NULL, H5VL_loc_params_t::obj_type, ret_value, and H5VL_loc_params_t::type.