Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2026-03-23 The HDF5 Field Guide

Loading...
Searching...
No Matches
H5Rpublic.h File Reference
`#include "H5public.h"`
`#include "H5Gpublic.h"`
`#include "H5Ipublic.h"`
`#include "H5Opublic.h"`

## Data Structures
struct | H5R_ref_t
struct | hdset_reg_ref_t

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

## 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
herr_t | H5Rcopy (const H5R_ref_t *src_ref_ptr, H5R_ref_t *dst_ref_ptr)
| Copies an existing reference.
herr_t | H5Rcreate (void *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, hid_t space_id)
| Creates a reference.
herr_t | H5Rcreate_attr (hid_t loc_id, const char *name, const char *attr_name, hid_t oapl_id, H5R_ref_t *ref_ptr)
| Creates an attribute reference.
herr_t | H5Rcreate_object (hid_t loc_id, const char *name, hid_t oapl_id, H5R_ref_t *ref_ptr)
| Creates an object reference.
herr_t | H5Rcreate_region (hid_t loc_id, const char *name, hid_t space_id, hid_t oapl_id, H5R_ref_t *ref_ptr)
| Creates a region reference.
hid_t | H5Rdereference1 (hid_t obj_id, H5R_type_t ref_type, const void *ref)
| Opens the HDF5 object referenced.
hid_t | H5Rdereference2 (hid_t obj_id, hid_t oapl_id, H5R_type_t ref_type, const void *ref)
| Opens the HDF5 object referenced.
herr_t | H5Rdestroy (H5R_ref_t *ref_ptr)
| Closes a reference.
htri_t | H5Requal (const H5R_ref_t *ref1_ptr, const H5R_ref_t *ref2_ptr)
| Determines whether two references are equal.
ssize_t | H5Rget_attr_name (const H5R_ref_t *ref_ptr, char *name, size_t size)
| Retrieves the attribute name for a referenced object.
ssize_t | H5Rget_file_name (const H5R_ref_t *ref_ptr, char *name, size_t size)
| Retrieves the file name for a referenced object.
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.
ssize_t | H5Rget_obj_name (H5R_ref_t *ref_ptr, hid_t rapl_id, char *name, size_t size)
| Retrieves the object name for a referenced object.
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.
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.
herr_t | H5Rget_obj_type3 (H5R_ref_t *ref_ptr, hid_t rapl_id, H5O_type_t *obj_type)
| Retrieves the type of object that an object reference points to.
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.
H5R_type_t | H5Rget_type (const H5R_ref_t *ref_ptr)
| Retrieves the type of a reference.
hid_t | H5Ropen_attr (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id)
| Opens the HDF5 attribute referenced.
hid_t | H5Ropen_attr_async (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id, hid_t es_id)
hid_t | H5Ropen_object (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id)
| Opens the HDF5 object referenced.
hid_t | H5Ropen_object_async (unsigned app_line, H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id, hid_t es_id)
hid_t | H5Ropen_region (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id)
| Sets up a dataspace and selection as specified by a region reference.
hid_t | H5Ropen_region_async (H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id, hid_t es_id)

## 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)

Default reference buffer size.

Since
  1.12.0

## Typedef Documentation

## ◆ hobj_ref_t

typedef haddr_t hobj_ref_t

Deprecated
  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

Reference types allowed.

Enumerator
H5R_BADTYPE | Invalid reference type Since 1.0.0
H5R_OBJECT1 | Backward compatibility (object) Since 1.12.0
H5R_DATASET_REGION1 | Backward compatibility (region) Since 1.12.0
H5R_OBJECT2 | Object reference Since 1.12.0
H5R_DATASET_REGION2 | Region reference Since 1.12.0
H5R_ATTR | Attribute Reference Since 1.12.0
H5R_MAXTYPE | Highest type (invalid) Since 1.0.0