Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
H5Ldevelop.h File Reference
#include "H5Lpublic.h"

Data Structures

struct  H5L_class_t
 Link prototype. More...
 
struct  H5L_class_0_t
 

Macros

#define H5L_LINK_CLASS_T_VERS   1
 Current version of the H5L_class_t struct.
 
#define H5L_EXT_VERSION   0
 Version of external link format.
 
#define H5L_EXT_FLAGS_ALL   0
 Valid flags for external links.
 
#define H5L_LINK_CLASS_T_VERS_0   0
 

Typedefs

typedef herr_t(* H5L_create_func_t) (const char *link_name, hid_t loc_group, const void *lnkdata, size_t lnkdata_size, hid_t lcpl_id)
 Link creation callback.
 
typedef herr_t(* H5L_move_func_t) (const char *new_name, hid_t new_loc, const void *lnkdata, size_t lnkdata_size)
 Callback for link move.
 
typedef herr_t(* H5L_copy_func_t) (const char *new_name, hid_t new_loc, const void *lnkdata, size_t lnkdata_size)
 Callback for link copy.
 
typedef hid_t(* H5L_traverse_func_t) (const char *link_name, hid_t cur_group, const void *lnkdata, size_t lnkdata_size, hid_t lapl_id, hid_t dxpl_id)
 Callback during link traversal.
 
typedef herr_t(* H5L_delete_func_t) (const char *link_name, hid_t file, const void *lnkdata, size_t lnkdata_size)
 Callback for link deletion.
 
typedef ssize_t(* H5L_query_func_t) (const char *link_name, const void *lnkdata, size_t lnkdata_size, void *buf, size_t buf_size)
 Callback for querying the link.
 
typedef hid_t(* H5L_traverse_0_func_t) (const char *link_name, hid_t cur_group, const void *lnkdata, size_t lnkdata_size, hid_t lapl_id)
 

Functions

herr_t H5Lregister (const H5L_class_t *cls)
 Registers a user-defined link class or changes behavior of an existing class.
 
herr_t H5Lunregister (H5L_type_t id)
 Unregisters a class of user-defined links.
 

Macro Definition Documentation

◆ H5L_EXT_FLAGS_ALL

#define H5L_EXT_FLAGS_ALL   0

Valid flags for external links.

◆ H5L_EXT_VERSION

#define H5L_EXT_VERSION   0

Version of external link format.

◆ H5L_LINK_CLASS_T_VERS

#define H5L_LINK_CLASS_T_VERS   1

Current version of the H5L_class_t struct.

◆ H5L_LINK_CLASS_T_VERS_0

#define H5L_LINK_CLASS_T_VERS_0   0

Typedef Documentation

◆ H5L_copy_func_t

typedef herr_t(* H5L_copy_func_t) (const char *new_name, hid_t new_loc, const void *lnkdata, size_t lnkdata_size)

Callback for link copy.

◆ H5L_create_func_t

typedef herr_t(* H5L_create_func_t) (const char *link_name, hid_t loc_group, const void *lnkdata, size_t lnkdata_size, hid_t lcpl_id)

Link creation callback.

◆ H5L_delete_func_t

typedef herr_t(* H5L_delete_func_t) (const char *link_name, hid_t file, const void *lnkdata, size_t lnkdata_size)

Callback for link deletion.

◆ H5L_move_func_t

typedef herr_t(* H5L_move_func_t) (const char *new_name, hid_t new_loc, const void *lnkdata, size_t lnkdata_size)

Callback for link move.

◆ H5L_query_func_t

typedef ssize_t(* H5L_query_func_t) (const char *link_name, const void *lnkdata, size_t lnkdata_size, void *buf, size_t buf_size)

Callback for querying the link.

Returns the size of the buffer needed.

◆ H5L_traverse_0_func_t

typedef hid_t(* H5L_traverse_0_func_t) (const char *link_name, hid_t cur_group, const void *lnkdata, size_t lnkdata_size, hid_t lapl_id)

Callback during link traversal

◆ H5L_traverse_func_t

typedef hid_t(* H5L_traverse_func_t) (const char *link_name, hid_t cur_group, const void *lnkdata, size_t lnkdata_size, hid_t lapl_id, hid_t dxpl_id)

Callback during link traversal.