H5Rpublic.h File Reference

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

Macros
#define	H5R_OBJ_REF_BUF_SIZE   sizeof(haddr_t)
#define	H5R_DSET_REG_REF_BUF_SIZE   (sizeof(haddr_t) + 4)

Typedefs
typedef haddr_t	hobj_ref_t
typedef unsigned char	hdset_reg_ref_t[(sizeof(haddr_t)+4)]

Enumerations
enum	H5R_type_t { H5R_BADTYPE = (-1), H5R_OBJECT, H5R_DATASET_REGION, H5R_MAXTYPE }

Functions
herr_t	H5Rcreate (void *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, hid_t space_id)
	Creates a reference. More...
hid_t	H5Rdereference2 (hid_t obj_id, hid_t oapl_id, H5R_type_t ref_type, const void *ref)
	Opens the HDF5 object referenced. More...
hid_t	H5Rget_region (hid_t dataset, H5R_type_t ref_type, const void *ref)
	Sets up a dataspace and selection as specified by a region reference. More...
herr_t	H5Rget_obj_type2 (hid_t id, H5R_type_t ref_type, const void *_ref, H5O_type_t *obj_type)
	Retrieves the type of object that an object reference points to. More...
ssize_t	H5Rget_name (hid_t loc_id, H5R_type_t ref_type, const void *ref, char *name, size_t size)
	Retrieves a name for a referenced object. More...
H5G_obj_t	H5Rget_obj_type1 (hid_t id, H5R_type_t ref_type, const void *ref)
	Retrieves the type of object that an object reference points to. More...
hid_t	H5Rdereference1 (hid_t obj_id, H5R_type_t ref_type, const void *ref)
	Opens the HDF5 object referenced. More...

Macro Definition Documentation

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)

Typedef Documentation

hdset_reg_ref_t

typedef unsigned char hdset_reg_ref_t[(sizeof(haddr_t)+4)]

Dataset Region reference structure for user's code (Buffer to store heap ID and index) This needs to be large enough to store largest haddr_t in a worst case machine (8 bytes currently) plus an int

hobj_ref_t

typedef haddr_t hobj_ref_t

Object reference structure for user's code This needs to be large enough to store largest haddr_t on a worst case machine (8 bytes currently).

Enumeration Type Documentation

H5R_type_t

enum H5R_type_t

Reference types allowed.

Enumerator
H5R_BADTYPE	Invalid reference type
H5R_OBJECT	Object reference
H5R_DATASET_REGION	Dataset Region Reference
H5R_MAXTYPE	Highest type (invalid)