H5Rpublic.h File Reference

Data Structures
struct	hdset_reg_ref_t
struct	H5R_ref_t

Typedefs
typedef haddr_t	hobj_ref_t

Enumerations
enum	H5R_type_t {   H5R_BADTYPE = (-1), H5R_OBJECT1 = 0, H5R_DATASET_REGION1 = 1, H5R_OBJECT2 = 2,   H5R_DATASET_REGION2 = 3, H5R_ATTR = 4, H5R_MAXTYPE = 5 }

Functions
H5_DLL herr_t	H5Rcreate_object (hid_t loc_id, const char *name, hid_t oapl_id, H5R_ref_t *ref_ptr)
H5_DLL herr_t	H5Rcreate_region (hid_t loc_id, const char *name, hid_t space_id, hid_t oapl_id, H5R_ref_t *ref_ptr)
H5_DLL herr_t	H5Rcreate_attr (hid_t loc_id, const char *name, const char *attr_name, hid_t oapl_id, H5R_ref_t *ref_ptr)
H5_DLL herr_t	H5Rdestroy (H5R_ref_t *ref_ptr)
H5_DLL H5R_type_t	H5Rget_type (const H5R_ref_t *ref_ptr)
H5_DLL htri_t	H5Requal (const H5R_ref_t *ref1_ptr, const H5R_ref_t *ref2_ptr)
H5_DLL herr_t	H5Rcopy (const H5R_ref_t *src_ref_ptr, H5R_ref_t *dst_ref_ptr)
H5_DLL hid_t	H5Ropen_object (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id)
H5_DLL hid_t	H5Ropen_region (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id)
H5_DLL hid_t	H5Ropen_attr (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id)
H5_DLL herr_t	H5Rget_obj_type3 (H5R_ref_t *ref_ptr, hid_t rapl_id, H5O_type_t *obj_type)
H5_DLL ssize_t	H5Rget_file_name (const H5R_ref_t *ref_ptr, char *buf, size_t size)
H5_DLL ssize_t	H5Rget_obj_name (H5R_ref_t *ref_ptr, hid_t rapl_id, char *buf, size_t size)
H5_DLL ssize_t	H5Rget_attr_name (const H5R_ref_t *ref_ptr, char *buf, size_t size)
H5_DLL H5G_obj_t	H5Rget_obj_type1 (hid_t id, H5R_type_t ref_type, const void *ref)
H5_DLL hid_t	H5Rdereference1 (hid_t obj_id, H5R_type_t ref_type, const void *ref)
H5_DLL herr_t	H5Rcreate (void *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, hid_t space_id)
H5_DLL herr_t	H5Rget_obj_type2 (hid_t id, H5R_type_t ref_type, const void *ref, H5O_type_t *obj_type)
H5_DLL hid_t	H5Rdereference2 (hid_t obj_id, hid_t oapl_id, H5R_type_t ref_type, const void *ref)
H5_DLL hid_t	H5Rget_region (hid_t dataset, H5R_type_t ref_type, const void *ref)
H5_DLL ssize_t	H5Rget_name (hid_t loc_id, H5R_type_t ref_type, const void *ref, char *name, size_t size)

Typedef Documentation

hobj_ref_t

typedef haddr_t hobj_ref_t

Deprecated object reference type that is used with deprecated reference APIs. Note! This type can only be used with the "native" HDF5 VOL connector.

Enumeration Type Documentation

H5R_type_t

enum H5R_type_t

Enumerator
H5R_BADTYPE
H5R_OBJECT1
H5R_DATASET_REGION1
H5R_OBJECT2
H5R_DATASET_REGION2
H5R_ATTR
H5R_MAXTYPE

Function Documentation

H5Rcopy()

H5_DLL herr_t H5Rcopy	(	const H5R_ref_t *	src_ref_ptr,
		H5R_ref_t *	dst_ref_ptr
	)

References FAIL, H5R__copy(), NULL, and ret_value.

H5Rcreate()

H5_DLL herr_t H5Rcreate	(	void *	ref,
		hid_t	loc_id,
		const char *	name,
		H5R_type_t	ref_type,
		hid_t	space_id
	)

References f, FAIL, H5CX_set_loc(), H5E_BADVALUE, H5F_get_file_id(), H5I_BADID, H5I_DATASPACE, H5I_dec_ref(), H5I_get_type(), H5I_object_verify(), H5R__encode_token_obj_compat(), H5R__encode_token_region_compat(), H5R_DATASET_REGION1, H5R_OBJECT1, H5VL_file_get(), H5VL_FILE_GET_CONT_INFO, H5VL_OBJECT_BY_NAME, H5VL_object_data(), H5VL_object_is_native(), H5VL_OBJECT_LOOKUP, H5VL_object_specific(), H5VL_vol_object(), HDassert(), 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, H5VL_file_cont_info_t::token_size, and H5VL_loc_params_t::type.

H5Rcreate_attr()

H5_DLL herr_t H5Rcreate_attr	(	hid_t	loc_id,
		const char *	name,
		const char *	attr_name,
		hid_t	oapl_id,
		H5R_ref_t *	ref_ptr
	)

References FAIL, H5E_BADVALUE, H5F_get_file_id(), H5I_dec_ref(), H5I_get_type(), H5P_isa_class(), H5R__create_attr(), H5R__set_loc_id(), H5VL_file_get(), H5VL_FILE_GET_CONT_INFO, H5VL_OBJECT_BY_NAME, H5VL_OBJECT_LOOKUP, H5VL_object_specific(), 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, H5VL_file_cont_info_t::token_size, and H5VL_loc_params_t::type.

H5Rcreate_object()

H5_DLL herr_t H5Rcreate_object	(	hid_t	loc_id,
		const char *	name,
		hid_t	oapl_id,
		H5R_ref_t *	ref_ptr
	)

References FAIL, H5E_BADVALUE, H5F_get_file_id(), H5I_dec_ref(), H5I_get_type(), H5P_isa_class(), H5R__create_object(), H5R__set_loc_id(), H5VL_file_get(), H5VL_FILE_GET_CONT_INFO, H5VL_OBJECT_BY_NAME, H5VL_OBJECT_LOOKUP, H5VL_object_specific(), 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, H5VL_file_cont_info_t::token_size, and H5VL_loc_params_t::type.

H5Rcreate_region()

H5_DLL herr_t H5Rcreate_region	(	hid_t	loc_id,
		const char *	name,
		hid_t	space_id,
		hid_t	oapl_id,
		H5R_ref_t *	ref_ptr
	)

References FAIL, H5E_BADVALUE, H5F_get_file_id(), H5I_BADID, H5I_DATASPACE, H5I_dec_ref(), H5I_get_type(), H5I_object_verify(), H5P_isa_class(), H5R__create_region(), H5R__set_loc_id(), H5VL_file_get(), H5VL_FILE_GET_CONT_INFO, H5VL_OBJECT_BY_NAME, H5VL_OBJECT_LOOKUP, H5VL_object_specific(), 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, H5VL_file_cont_info_t::token_size, and H5VL_loc_params_t::type.

H5Rdereference1()

H5_DLL hid_t H5Rdereference1	(	hid_t	obj_id,
		H5R_type_t	ref_type,
		const void *	ref
	)

References H5VL_object_t::connector, H5E_BADVALUE, H5E_CANTREGISTER, H5I_BADID, H5I_get_type(), H5R__decode_token_compat(), H5R_DATASET_REGION1, H5R_OBJECT1, H5VL_OBJECT_BY_TOKEN, H5VL_object_open(), H5VL_register(), H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rdereference2()

H5_DLL hid_t H5Rdereference2	(	hid_t	obj_id,
		hid_t	oapl_id,
		H5R_type_t	ref_type,
		const void *	ref
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_BADID, H5I_get_type(), H5P_CLS_DACC, H5R__decode_token_compat(), H5R_DATASET_REGION1, H5R_OBJECT1, H5VL_OBJECT_BY_TOKEN, H5VL_object_open(), H5VL_register(), H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rdestroy()

H5_DLL herr_t H5Rdestroy

(

H5R_ref_t *

ref_ptr

)

References FAIL, H5R__destroy(), NULL, and ret_value.

H5Requal()

H5_DLL htri_t H5Requal	(	const H5R_ref_t *	ref1_ptr,
		const H5R_ref_t *	ref2_ptr
	)

References FAIL, H5E_BADVALUE, H5R__equal(), and ret_value.

H5Rget_attr_name()

H5_DLL ssize_t H5Rget_attr_name	(	const H5R_ref_t *	ref_ptr,
		char *	buf,
		size_t	size
	)

References H5E_BADVALUE, H5R__get_attr_name(), H5R__get_type(), H5R_ATTR, NULL, ret_value, and size.

H5Rget_file_name()

H5_DLL ssize_t H5Rget_file_name	(	const H5R_ref_t *	ref_ptr,
		char *	buf,
		size_t	size
	)

References H5E_BADVALUE, H5I_FILE, H5R__get_file_name(), H5R__get_loc_id(), H5R__get_type(), H5R_BADTYPE, H5R_MAXTYPE, H5VL_file_get(), H5VL_FILE_GET_NAME, H5VL_vol_object(), NULL, ret_value, and size.

H5Rget_name()

H5_DLL ssize_t H5Rget_name	(	hid_t	loc_id,
		H5R_type_t	ref_type,
		const void *	ref,
		char *	name,
		size_t	size
	)

References H5E_BADVALUE, H5I_BADID, H5I_get_type(), H5R__decode_token_compat(), H5R_DATASET_REGION1, H5R_OBJECT1, H5VL_OBJECT_BY_TOKEN, H5VL_object_get(), H5VL_OBJECT_GET_NAME, H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, name, NULL, H5VL_loc_params_t::obj_type, ret_value, size, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rget_obj_name()

H5_DLL ssize_t H5Rget_obj_name	(	H5R_ref_t *	ref_ptr,
		hid_t	rapl_id,
		char *	buf,
		size_t	size
	)

References H5E_BADVALUE, H5I_get_type(), H5R__get_loc_id(), H5R__get_obj_token(), H5R__get_type(), H5R__reopen_file(), H5R_BADTYPE, H5R_MAXTYPE, H5VL_OBJECT_BY_TOKEN, H5VL_object_get(), H5VL_OBJECT_GET_NAME, H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, size, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rget_obj_type1()

H5_DLL H5G_obj_t H5Rget_obj_type1	(	hid_t	id,
		H5R_type_t	ref_type,
		const void *	ref
	)

References H5E_BADVALUE, H5G_map_obj_type(), H5G_UNKNOWN, H5I_BADID, H5I_get_type(), H5R__decode_token_compat(), H5R_DATASET_REGION1, H5R_OBJECT1, H5VL_OBJECT_BY_TOKEN, H5VL_object_get(), H5VL_OBJECT_GET_TYPE, H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rget_obj_type2()

H5_DLL herr_t H5Rget_obj_type2	(	hid_t	id,
		H5R_type_t	ref_type,
		const void *	ref,
		H5O_type_t *	obj_type
	)

References FAIL, H5E_BADVALUE, H5I_BADID, H5I_get_type(), H5R__decode_token_compat(), H5R_DATASET_REGION1, H5R_OBJECT1, H5VL_OBJECT_BY_TOKEN, H5VL_object_get(), H5VL_OBJECT_GET_TYPE, H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rget_obj_type3()

H5_DLL herr_t H5Rget_obj_type3	(	H5R_ref_t *	ref_ptr,
		hid_t	rapl_id,
		H5O_type_t *	obj_type
	)

References FAIL, H5E_BADVALUE, H5I_get_type(), H5R__get_loc_id(), H5R__get_obj_token(), H5R__get_type(), H5R__reopen_file(), H5R_BADTYPE, H5R_MAXTYPE, H5VL_OBJECT_BY_TOKEN, H5VL_object_get(), H5VL_OBJECT_GET_TYPE, H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Rget_region()

H5_DLL hid_t H5Rget_region	(	hid_t	dataset,
		H5R_type_t	ref_type,
		const void *	ref
	)

References f, H5E_BADVALUE, H5E_CANTREGISTER, H5F_get_file_id(), H5I_BADID, H5I_DATASPACE, H5I_dec_ref(), H5I_get_type(), H5I_register(), H5R__decode_token_region_compat(), H5R_DATASET_REGION1, H5VL_file_get(), H5VL_FILE_GET_CONT_INFO, H5VL_object_data(), H5VL_object_is_native(), H5VL_vol_object(), HDassert(), NULL, ret_value, and H5VL_file_cont_info_t::token_size.

H5Rget_type()

H5_DLL H5R_type_t H5Rget_type

(

const H5R_ref_t *

ref_ptr

)

References H5E_BADVALUE, H5R__get_type(), H5R_BADTYPE, H5R_MAXTYPE, NULL, and ret_value.

H5Ropen_attr()

H5_DLL hid_t H5Ropen_attr	(	H5R_ref_t *	ref_ptr,
		hid_t	rapl_id,
		hid_t	aapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_ATTR, H5I_dec_ref(), H5I_get_type(), H5P_CLS_AACC, H5R__get_loc_id(), H5R__get_obj_token(), H5R__get_type(), H5R__reopen_file(), H5R_ATTR, H5VL_attr_close(), H5VL_attr_open(), H5VL_OBJECT_BY_SELF, H5VL_OBJECT_BY_TOKEN, H5VL_object_open(), H5VL_register(), H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Ropen_object()

H5_DLL hid_t H5Ropen_object	(	H5R_ref_t *	ref_ptr,
		hid_t	rapl_id,
		hid_t	oapl_id
	)

References H5VL_object_t::connector, H5CX_set_apl(), H5E_BADVALUE, H5E_CANTREGISTER, H5I_get_type(), H5P_CLS_DACC, H5R__get_loc_id(), H5R__get_obj_token(), H5R__get_type(), H5R__reopen_file(), H5R_BADTYPE, H5R_MAXTYPE, H5VL_OBJECT_BY_TOKEN, H5VL_object_open(), H5VL_register(), H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.

H5Ropen_region()

H5_DLL hid_t H5Ropen_region	(	H5R_ref_t *	ref_ptr,
		hid_t	rapl_id,
		hid_t	oapl_id
	)

References H5VL_object_t::connector, H5E_BADVALUE, H5E_CANTREGISTER, H5I_DATASPACE, H5I_dec_ref(), H5I_get_type(), H5I_object_verify(), H5R__get_loc_id(), H5R__get_obj_token(), H5R__get_region(), H5R__get_type(), H5R__reopen_file(), H5R_DATASET_REGION1, H5R_DATASET_REGION2, H5VL_dataset_get(), H5VL_DATASET_GET_SPACE, H5VL_OBJECT_BY_TOKEN, H5VL_object_open(), H5VL_register(), H5VL_vol_object(), H5VL_loc_params_t::loc_by_token, H5VL_loc_params_t::loc_data, NULL, H5VL_loc_params_t::obj_type, ret_value, H5VL_loc_by_token::token, and H5VL_loc_params_t::type.