H5Rpublic.h File Reference

#include "H5public.h"
#include "H5Gpublic.h"
#include "H5Ipublic.h"

Data Structures
struct	hdset_reg_ref_t
struct	H5R_ref_t

Macros
#define	H5R_OBJ_REF_BUF_SIZE   sizeof(haddr_t)
#define	H5R_DSET_REG_REF_BUF_SIZE   (sizeof(haddr_t) + 4)
#define	H5R_REF_BUF_SIZE   (64)
#define	H5R_OBJECT   H5R_OBJECT1
#define	H5R_DATASET_REGION   H5R_DATASET_REGION1

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, H5R_BADTYPE = (-1),   H5R_OBJECT1 = 0, H5R_DATASET_REGION1 = 1, H5R_OBJECT2 = 2, H5R_DATASET_REGION2 = 3,   H5R_ATTR = 4, H5R_MAXTYPE = 5 }

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

Macro Definition Documentation

H5R_DATASET_REGION

#define H5R_DATASET_REGION   H5R_DATASET_REGION1

H5R_DSET_REG_REF_BUF_SIZE

#define H5R_DSET_REG_REF_BUF_SIZE   (sizeof(haddr_t) + 4)

H5R_OBJ_REF_BUF_SIZE

#define H5R_OBJ_REF_BUF_SIZE   sizeof(haddr_t)

H5R_OBJECT

#define H5R_OBJECT   H5R_OBJECT1

H5R_REF_BUF_SIZE

#define H5R_REF_BUF_SIZE   (64)

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
H5R_BADTYPE
H5R_OBJECT1
H5R_DATASET_REGION1
H5R_OBJECT2
H5R_DATASET_REGION2
H5R_ATTR
H5R_MAXTYPE

Function Documentation

H5Rcopy()

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

H5Rcreate()

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

H5Rcreate_attr()

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

H5Rcreate_object()

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

H5Rcreate_region()

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

H5Rdereference1()

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

H5Rdereference2()

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

H5Rdestroy()

herr_t H5Rdestroy

(

H5R_ref_t *

ref_ptr

)

H5Requal()

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

H5Rget_attr_name()

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

H5Rget_file_name()

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

H5Rget_name()

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

H5Rget_obj_name()

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

H5Rget_obj_type1()

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

H5Rget_obj_type2()

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

H5Rget_obj_type3()

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

H5Rget_region()

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

H5Rget_type()

H5R_type_t H5Rget_type

(

const H5R_ref_t *

ref_ptr

)

H5Ropen_attr()

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

H5Ropen_object()

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

H5Ropen_region()

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