H5Lpublic.h File Reference

#include "H5public.h"
#include "H5Ipublic.h"
#include "H5Tpublic.h"

Data Structures
struct	H5L_info_t
	Information struct for links. More...
struct	H5L_class_t
	Link prototype. More...

Macros
#define	H5L_MAX_LINK_NAME_LEN   ((uint32_t)(-1)) /* (4GB - 1) */
	Maximum length of a link's name. More...
#define	H5L_SAME_LOC   (hid_t)0
	Macro to indicate operation occurs on same location. More...
#define	H5L_LINK_CLASS_T_VERS   0
	Current version of the H5L_class_t struct. More...
#define	H5L_TYPE_BUILTIN_MAX   H5L_TYPE_SOFT
	Maximum value link value for "built-in" link types. More...
#define	H5L_TYPE_UD_MIN   H5L_TYPE_EXTERNAL
	Link ids at or above this value are "user-defined" link types. More...

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. More...
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. More...
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. More...
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)
	Callback during link traversal. More...
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. More...
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. More...
typedef herr_t(*	H5L_iterate_t) (hid_t group, const char *name, const H5L_info_t *info, void *op_data)
	Prototype for H5Literate(), H5Literate_by_name() operator. More...
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)
	Callback for external link traversal. More...

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 }
	Link class types. More...

Functions
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)
	Moves a link within an HDF5 file. More...
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)
	Creates an identical copy of a link with the same creation time and target. The new link can have a different name and be in a different location than the original. More...
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)
	Creates a hard link to an object. More...
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)
	Creates a soft link. More...
herr_t	H5Ldelete (hid_t loc_id, const char *name, hid_t lapl_id)
	Removes a link from a group. More...
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)
	Removes the n-th link in a group. More...
herr_t	H5Lget_val (hid_t loc_id, const char *name, void *buf, size_t size, hid_t lapl_id)
	Returns the value of a link. More...
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)
	Retrieves value of the n-th link in a group, according to the order within an index. More...
htri_t	H5Lexists (hid_t loc_id, const char *name, hid_t lapl_id)
	Determines whether a link with the specified name exists in a group. More...
herr_t	H5Lget_info (hid_t loc_id, const char *name, H5L_info_t *linfo, hid_t lapl_id)
	Returns information about a link. More...
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)
	Retrieves metadata for a link in a group, according to the order within a field or index. More...
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)
	Retrieves name of the n-th link in a group, according to the order within a specified field or index. More...
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)
	Iterates over links in a group, with user callback routine, according to the order within an index. More...
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)
	Iterates through links in a group. More...
herr_t	H5Lvisit (hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data)
	Recursively visits all links starting from a specified group. More...
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)
	Recursively visits all links starting from a specified group. More...
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)
	Creates a link of a user-defined type. More...
herr_t	H5Lregister (const H5L_class_t *cls)
	Registers a user-defined link class or changes behavior of an existing class. More...
herr_t	H5Lunregister (H5L_type_t id)
	Unregisters a class of user-defined links. More...
htri_t	H5Lis_registered (H5L_type_t id)
	Determines whether a class of user-defined links is registered. More...
herr_t	H5Lunpack_elink_val (const void *ext_linkval, size_t link_size, unsigned *flags, const char **filename, const char **obj_path)
	Decodes external link information. More...
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)
	Creates an external link, a soft link to an object in a different file. More...

Macro Definition Documentation

H5L_LINK_CLASS_T_VERS

#define H5L_LINK_CLASS_T_VERS   0

Current version of the H5L_class_t struct.

H5L_MAX_LINK_NAME_LEN

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

Maximum length of a link's name.

The maximum length of a link's name is encoded in a 32-bit unsigned integer.

H5L_SAME_LOC

#define H5L_SAME_LOC   (hid_t)0

Macro to indicate operation occurs on same location.

H5L_TYPE_BUILTIN_MAX

#define H5L_TYPE_BUILTIN_MAX   H5L_TYPE_SOFT

Maximum value link value for "built-in" link types.

H5L_TYPE_UD_MIN

#define H5L_TYPE_UD_MIN   H5L_TYPE_EXTERNAL

Link ids at or above this value are "user-defined" link types.

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_elink_traverse_t

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)

Callback for external link traversal.

H5L_iterate_t

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

Prototype for H5Literate(), H5Literate_by_name() operator.

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

Callback during link traversal.

Enumeration Type Documentation

H5L_type_t

enum H5L_type_t

Link class types.

Values less than 64 are reserved for the HDF5 library's internal use. Values 64 to 255 are for "user-defined" link class types; these types are defined by HDF5 but their behavior can be overridden by users. Users who want to create new classes of links should contact the HDF5 development team at help@.nosp@m.hdfg.nosp@m.roup..nosp@m.org. These values can never change because they appear in HDF5 files.

Enumerator
H5L_TYPE_ERROR	Invalid link type id
H5L_TYPE_HARD	Hard link id
H5L_TYPE_SOFT	Soft link id
H5L_TYPE_EXTERNAL	External link id
H5L_TYPE_MAX	Maximum link type id