HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
H5Lpublic.h File Reference
#include "H5public.h"
#include "H5Ipublic.h"
#include "H5Tpublic.h"
+ Include dependency graph for H5Lpublic.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  H5L_info_t
 
struct  H5L_class_t
 

Macros

#define H5L_MAX_LINK_NAME_LEN   ((uint32_t)(-1)) /* (4GB - 1) */
 
#define H5L_SAME_LOC   0
 
#define H5L_LINK_CLASS_T_VERS   0
 
#define H5L_TYPE_BUILTIN_MAX   H5L_TYPE_SOFT /* Maximum value link value for "built-in" link types */
 
#define H5L_TYPE_UD_MIN   H5L_TYPE_EXTERNAL /* Link ids at or above this value are "user-defined" link types. */
 

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)
 
typedef herr_t(* H5L_move_func_t )(const char *new_name, hid_t new_loc, const void *lnkdata, size_t lnkdata_size)
 
typedef herr_t(* H5L_copy_func_t )(const char *new_name, hid_t new_loc, const void *lnkdata, size_t lnkdata_size)
 
typedef herr_t(* H5L_traverse_func_t )(const char *link_name, hid_t cur_group, const void *lnkdata, size_t lnkdata_size, hid_t lapl_id)
 
typedef herr_t(* H5L_delete_func_t )(const char *link_name, hid_t file, const void *lnkdata, size_t lnkdata_size)
 
typedef ssize_t(* H5L_query_func_t )(const char *link_name, const void *lnkdata, size_t lnkdata_size, void *buf, size_t buf_size)
 
typedef herr_t(* H5L_iterate_t )(hid_t group, const char *name, const H5L_info_t *info, void *op_data)
 
typedef herr_t(* H5L_elink_traverse_t )(const char *parent_file_name, const char *parent_group_name, const char *child_file_name, const char *child_object_name, unsigned *acc_flags, hid_t fapl_id, void *op_data)
 

Enumerations

enum  H5L_type_t {
  H5L_TYPE_ERROR = (-1), H5L_TYPE_HARD = 0, H5L_TYPE_SOFT = 1, H5L_TYPE_EXTERNAL = 64,
  H5L_TYPE_MAX = 255
}
 

Functions

H5_DLL herr_t H5Lmove (hid_t src_loc, const char *src_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
 
H5_DLL herr_t H5Lcopy (hid_t src_loc, const char *src_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
 
H5_DLL herr_t H5Lcreate_hard (hid_t cur_loc, const char *cur_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
 
H5_DLL herr_t H5Lcreate_soft (const char *link_target, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id)
 
H5_DLL herr_t H5Ldelete (hid_t loc_id, const char *name, hid_t lapl_id)
 
H5_DLL herr_t H5Ldelete_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id)
 
H5_DLL herr_t H5Lget_val (hid_t loc_id, const char *name, void *buf, size_t size, hid_t lapl_id)
 
H5_DLL herr_t H5Lget_val_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, void *buf, size_t size, hid_t lapl_id)
 
H5_DLL htri_t H5Lexists (hid_t loc_id, const char *name, hid_t lapl_id)
 
H5_DLL herr_t H5Lget_info (hid_t loc_id, const char *name, H5L_info_t *linfo, hid_t lapl_id)
 
H5_DLL herr_t H5Lget_info_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5L_info_t *linfo, hid_t lapl_id)
 
H5_DLL ssize_t H5Lget_name_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, char *name, size_t size, hid_t lapl_id)
 
H5_DLL herr_t H5Literate (hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx, H5L_iterate_t op, void *op_data)
 
H5_DLL herr_t H5Literate_by_name (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx, H5L_iterate_t op, void *op_data, hid_t lapl_id)
 
H5_DLL herr_t H5Lvisit (hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data)
 
H5_DLL herr_t H5Lvisit_by_name (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data, hid_t lapl_id)
 
H5_DLL herr_t H5Lcreate_ud (hid_t link_loc_id, const char *link_name, H5L_type_t link_type, const void *udata, size_t udata_size, hid_t lcpl_id, hid_t lapl_id)
 
H5_DLL herr_t H5Lregister (const H5L_class_t *cls)
 
H5_DLL herr_t H5Lunregister (H5L_type_t id)
 
H5_DLL htri_t H5Lis_registered (H5L_type_t id)
 
H5_DLL herr_t H5Lunpack_elink_val (const void *ext_linkval, size_t link_size, unsigned *flags, const char **filename, const char **obj_path)
 
H5_DLL herr_t H5Lcreate_external (const char *file_name, const char *obj_name, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id)
 

Macro Definition Documentation

#define H5L_LINK_CLASS_T_VERS   0

Definition at line 46 of file H5Lpublic.h.

#define H5L_MAX_LINK_NAME_LEN   ((uint32_t)(-1)) /* (4GB - 1) */

Definition at line 40 of file H5Lpublic.h.

#define H5L_SAME_LOC   0

Definition at line 43 of file H5Lpublic.h.

#define H5L_TYPE_BUILTIN_MAX   H5L_TYPE_SOFT /* Maximum value link value for "built-in" link types */

Definition at line 71 of file H5Lpublic.h.

#define H5L_TYPE_UD_MIN   H5L_TYPE_EXTERNAL /* Link ids at or above this value are "user-defined" link types. */

Definition at line 72 of file H5Lpublic.h.

Typedef Documentation

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

Definition at line 100 of file H5Lpublic.h.

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)

Definition at line 92 of file H5Lpublic.h.

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

Definition at line 108 of file H5Lpublic.h.

typedef herr_t(* H5L_elink_traverse_t)(const char *parent_file_name, const char *parent_group_name, const char *child_file_name, const char *child_object_name, unsigned *acc_flags, hid_t fapl_id, void *op_data)

Definition at line 134 of file H5Lpublic.h.

typedef herr_t(* H5L_iterate_t)(hid_t group, const char *name, const H5L_info_t *info, void *op_data)

Definition at line 130 of file H5Lpublic.h.

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

Definition at line 96 of file H5Lpublic.h.

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

Definition at line 113 of file H5Lpublic.h.

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

Definition at line 104 of file H5Lpublic.h.

Enumeration Type Documentation

enum H5L_type_t
Enumerator
H5L_TYPE_ERROR 
H5L_TYPE_HARD 
H5L_TYPE_SOFT 
H5L_TYPE_EXTERNAL 
H5L_TYPE_MAX 

Definition at line 64 of file H5Lpublic.h.

Function Documentation

H5_DLL herr_t H5Lcopy ( hid_t  src_loc,
const char *  src_name,
hid_t  dst_loc,
const char *  dst_name,
hid_t  lcpl_id,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lcreate_external ( const char *  file_name,
const char *  obj_name,
hid_t  link_loc_id,
const char *  link_name,
hid_t  lcpl_id,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lcreate_hard ( hid_t  cur_loc,
const char *  cur_name,
hid_t  dst_loc,
const char *  dst_name,
hid_t  lcpl_id,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lcreate_soft ( const char *  link_target,
hid_t  link_loc_id,
const char *  link_name,
hid_t  lcpl_id,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lcreate_ud ( hid_t  link_loc_id,
const char *  link_name,
H5L_type_t  link_type,
const void udata,
size_t  udata_size,
hid_t  lcpl_id,
hid_t  lapl_id 
)
H5_DLL herr_t H5Ldelete ( hid_t  loc_id,
const char *  name,
hid_t  lapl_id 
)
H5_DLL herr_t H5Ldelete_by_idx ( hid_t  loc_id,
const char *  group_name,
H5_index_t  idx_type,
H5_iter_order_t  order,
hsize_t  n,
hid_t  lapl_id 
)
H5_DLL htri_t H5Lexists ( hid_t  loc_id,
const char *  name,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lget_info ( hid_t  loc_id,
const char *  name,
H5L_info_t linfo,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lget_info_by_idx ( hid_t  loc_id,
const char *  group_name,
H5_index_t  idx_type,
H5_iter_order_t  order,
hsize_t  n,
H5L_info_t linfo,
hid_t  lapl_id 
)
H5_DLL ssize_t H5Lget_name_by_idx ( hid_t  loc_id,
const char *  group_name,
H5_index_t  idx_type,
H5_iter_order_t  order,
hsize_t  n,
char *  name,
size_t  size,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lget_val ( hid_t  loc_id,
const char *  name,
void buf,
size_t  size,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lget_val_by_idx ( hid_t  loc_id,
const char *  group_name,
H5_index_t  idx_type,
H5_iter_order_t  order,
hsize_t  n,
void buf,
size_t  size,
hid_t  lapl_id 
)
H5_DLL htri_t H5Lis_registered ( H5L_type_t  id)
H5_DLL herr_t H5Literate ( hid_t  grp_id,
H5_index_t  idx_type,
H5_iter_order_t  order,
hsize_t idx,
H5L_iterate_t  op,
void op_data 
)
H5_DLL herr_t H5Literate_by_name ( hid_t  loc_id,
const char *  group_name,
H5_index_t  idx_type,
H5_iter_order_t  order,
hsize_t idx,
H5L_iterate_t  op,
void op_data,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lmove ( hid_t  src_loc,
const char *  src_name,
hid_t  dst_loc,
const char *  dst_name,
hid_t  lcpl_id,
hid_t  lapl_id 
)
H5_DLL herr_t H5Lregister ( const H5L_class_t cls)
H5_DLL herr_t H5Lunpack_elink_val ( const void ext_linkval,
size_t  link_size,
unsigned *  flags,
const char **  filename,
const char **  obj_path 
)
H5_DLL herr_t H5Lunregister ( H5L_type_t  id)
H5_DLL herr_t H5Lvisit ( hid_t  grp_id,
H5_index_t  idx_type,
H5_iter_order_t  order,
H5L_iterate_t  op,
void op_data 
)
H5_DLL herr_t H5Lvisit_by_name ( hid_t  loc_id,
const char *  group_name,
H5_index_t  idx_type,
H5_iter_order_t  order,
H5L_iterate_t  op,
void op_data,
hid_t  lapl_id 
)