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

| HDF5 Last Updated on 2025-11-11 The HDF5 Field Guide

- Main Page
- Getting started
- User Guide
- Reference Manual
- Cookbook
- Technical Notes
- RFCs
- Specifications
- Glossary
- Full-Text Search
- About

Loading...
Searching...
No Matches
Functions
Native VOL
VOL connector (H5VL)

## Detailed Description

## Functions
herr_t | H5VLnative_addr_to_token (hid_t loc_id, haddr_t addr, H5O_token_t *token)
| Convert a haddr_t address to a native VOL connector token.
herr_t | H5VLnative_token_to_addr (hid_t loc_id, H5O_token_t token, haddr_t *addr)
| Convert a native VOL connector token to a haddr_t address.

## Function Documentation

## ◆ H5VLnative_addr_to_token()

herr_t H5VLnative_addr_to_token | ( | hid_t | loc_id,
|  | haddr_t | addr,
|  | H5O_token_t * | token )

Convert a haddr_t address to a native VOL connector token.

Parameters

  [in] | loc_id | Location identifier of object. The identifier may be that of a file, group, dataset, named datatype, or attribute.
  [in] | addr | Object address
  [out] | token | Object token

Returns
  Returns a non-negative value if successful; otherwise, returns a negative value.

This API call maps pre-VOL haddr_t native file format addresses to the more generic H5O_token_t tokens used by the VOL.

Since
  1.12.0

## ◆ H5VLnative_token_to_addr()

herr_t H5VLnative_token_to_addr | ( | hid_t | loc_id,
|  | H5O_token_t | token,
|  | haddr_t * | addr )

Convert a native VOL connector token to a haddr_t address.

Parameters

  [in] | loc_id | Location identifier of object. The identifier may be that of a file, group, dataset, named datatype, or attribute.
  [in] | token | Object token
  [out] | addr | Object address

Returns
  Returns a non-negative value if successful; otherwise, returns a negative value.

This API call maps generic H5O_token_t tokens used by the VOL to pre-VOL haddr_t native file format addresses.

Since
  1.12.0