summaryrefslogtreecommitdiffstats
path: root/src/H5Lpublic.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5Lpublic.h')
-rw-r--r--src/H5Lpublic.h135
1 files changed, 65 insertions, 70 deletions
diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index 14975bc..e930a15 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -70,11 +70,11 @@ extern "C" {
* in HDF5 files.
*/
typedef enum {
- H5L_TYPE_ERROR = (-1), /**< Invalid link type id */
- H5L_TYPE_HARD = 0, /**< Hard link id */
- H5L_TYPE_SOFT = 1, /**< Soft link id */
- H5L_TYPE_EXTERNAL = 64, /**< External link id */
- H5L_TYPE_MAX = 255 /**< Maximum link type id */
+ H5L_TYPE_ERROR = (-1), /**< Invalid link type id */
+ H5L_TYPE_HARD = 0, /**< Hard link id */
+ H5L_TYPE_SOFT = 1, /**< Soft link id */
+ H5L_TYPE_EXTERNAL = 64, /**< External link id */
+ H5L_TYPE_MAX = 255 /**< Maximum link type id */
} H5L_type_t;
/**
* \brief Maximum value link value for "built-in" link types
@@ -83,24 +83,24 @@ typedef enum {
/**
* \brief Link ids at or above this value are "user-defined" link types.
*/
-#define H5L_TYPE_UD_MIN H5L_TYPE_EXTERNAL
+#define H5L_TYPE_UD_MIN H5L_TYPE_EXTERNAL
/**
* \brief Maximum link id value for "user-defined" link types.
*/
-#define H5L_TYPE_UD_MAX H5L_TYPE_MAX
+#define H5L_TYPE_UD_MAX H5L_TYPE_MAX
/**
* \brief Information struct for links
*/
//! [H5L_info2_t_snip]
typedef struct {
- H5L_type_t type; /**< Type of link */
- hbool_t corder_valid; /**< Indicate if creation order is valid */
- int64_t corder; /**< Creation order */
- H5T_cset_t cset; /**< Character set of link name */
+ H5L_type_t type; /**< Type of link */
+ hbool_t corder_valid; /**< Indicate if creation order is valid */
+ int64_t corder; /**< Creation order */
+ H5T_cset_t cset; /**< Character set of link name */
union {
- H5O_token_t token; /**< Token of location that hard link points to */
- size_t val_size; /**< Size of a soft link or user-defined link value */
+ H5O_token_t token; /**< Token of location that hard link points to */
+ size_t val_size; /**< Size of a soft link or user-defined link value */
} u;
} H5L_info2_t;
//! [H5L_info2_t_snip]
@@ -113,35 +113,35 @@ typedef struct {
/**
* \brief Link creation callback
*/
-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_create_func_t)(const char *link_name, hid_t loc_group, const void *lnkdata,
+ size_t lnkdata_size, hid_t lcpl_id);
/**
* \brief Callback for link move
*/
-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_move_func_t)(const char *new_name, hid_t new_loc, const void *lnkdata,
+ size_t lnkdata_size);
/**
* \brief Callback for link copy
*/
-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_copy_func_t)(const char *new_name, hid_t new_loc, const void *lnkdata,
+ size_t lnkdata_size);
/**
* \brief Callback during link traversal
*/
-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);
+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);
/**
* \brief Callback for link deletion
*/
-typedef herr_t (*H5L_delete_func_t)(const char *link_name, hid_t file,
- const void *lnkdata, size_t lnkdata_size);
+typedef herr_t (*H5L_delete_func_t)(const char *link_name, hid_t file, const void *lnkdata,
+ size_t lnkdata_size);
/**
* \brief Callback for querying the link.
*
* Returns the size of the buffer needed.
*/
-typedef ssize_t (*H5L_query_func_t)(const char *link_name, const void *lnkdata,
- size_t lnkdata_size, void *buf /*out*/, size_t buf_size);
+typedef ssize_t (*H5L_query_func_t)(const char *link_name, const void *lnkdata, size_t lnkdata_size,
+ void *buf /*out*/, size_t buf_size);
/**
* \brief Link prototype
@@ -152,15 +152,15 @@ typedef ssize_t (*H5L_query_func_t)(const char *link_name, const void *lnkdata,
*/
//! [H5L_class_t_snip]
typedef struct {
- int version; /**< Version number of this struct */
- H5L_type_t id; /**< Link type ID */
- const char *comment; /**< Comment for debugging */
- H5L_create_func_t create_func; /**< Callback during link creation */
- H5L_move_func_t move_func; /**< Callback after moving link */
- H5L_copy_func_t copy_func; /**< Callback after copying link */
- H5L_traverse_func_t trav_func; /**< Callback during link traversal */
- H5L_delete_func_t del_func; /**< Callback for link deletion */
- H5L_query_func_t query_func; /**< Callback for queries */
+ int version; /**< Version number of this struct */
+ H5L_type_t id; /**< Link type ID */
+ const char * comment; /**< Comment for debugging */
+ H5L_create_func_t create_func; /**< Callback during link creation */
+ H5L_move_func_t move_func; /**< Callback after moving link */
+ H5L_copy_func_t copy_func; /**< Callback after copying link */
+ H5L_traverse_func_t trav_func; /**< Callback during link traversal */
+ H5L_delete_func_t del_func; /**< Callback for link deletion */
+ H5L_query_func_t query_func; /**< Callback for queries */
} H5L_class_t;
//! [H5L_class_t_snip]
@@ -170,17 +170,15 @@ typedef struct {
* The H5O_token_t version is used in the VOL layer and future public API calls.
*/
//! [H5L_iterate2_t_snip]
-typedef herr_t (*H5L_iterate2_t)(hid_t group, const char *name, const H5L_info2_t *info,
- void *op_data);
+typedef herr_t (*H5L_iterate2_t)(hid_t group, const char *name, const H5L_info2_t *info, void *op_data);
//! [H5L_iterate2_t_snip]
/**
* \brief Callback for external link traversal
*/
-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);
+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);
/********************/
/* Public Variables */
@@ -768,7 +766,7 @@ H5_DLL htri_t H5Lexists(hid_t loc_id, const char *name, hid_t lapl_id);
* \since 1.12.0
*
*/
-H5_DLL herr_t H5Lget_info2(hid_t loc_id, const char *name, H5L_info2_t *linfo /*out*/, hid_t lapl_id);
+H5_DLL herr_t H5Lget_info2(hid_t loc_id, const char *name, H5L_info2_t *linfo, hid_t lapl_id);
/**
* \ingroup H5L
*
@@ -823,8 +821,7 @@ H5_DLL herr_t H5Lget_info2(hid_t loc_id, const char *name, H5L_info2_t *linfo /*
*
*/
H5_DLL herr_t H5Lget_info_by_idx2(hid_t loc_id, const char *group_name, H5_index_t idx_type,
- H5_iter_order_t order, hsize_t n, H5L_info2_t *linfo /*out*/,
- hid_t lapl_id);
+ H5_iter_order_t order, hsize_t n, H5L_info2_t *linfo, hid_t lapl_id);
/**
* \ingroup H5L
*
@@ -945,8 +942,8 @@ H5_DLL ssize_t H5Lget_name_by_idx(hid_t loc_id, const char *group_name, H5_index
* \see H5Literate_by_name2(), H5Lvisit2(), H5Lvisit_by_name2()
*
*/
-H5_DLL herr_t H5Literate2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx,
- H5L_iterate2_t op, void *op_data);
+H5_DLL herr_t H5Literate2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx,
+ H5L_iterate2_t op, void *op_data);
/**
* \ingroup TRAV
*
@@ -1011,9 +1008,9 @@ H5_DLL herr_t H5Literate2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t or
* \see H5Literate(), H5Lvisit()
*
*/
-H5_DLL herr_t H5Literate_by_name2(hid_t loc_id, const char *group_name, H5_index_t idx_type,
- H5_iter_order_t order, hsize_t *idx, H5L_iterate2_t op, void *op_data,
- hid_t lapl_id);
+H5_DLL herr_t H5Literate_by_name2(hid_t loc_id, const char *group_name, H5_index_t idx_type,
+ H5_iter_order_t order, hsize_t *idx, H5L_iterate2_t op, void *op_data,
+ hid_t lapl_id);
/**
* \ingroup TRAV
*
@@ -1095,8 +1092,8 @@ H5_DLL herr_t H5Literate_by_name2(hid_t loc_id, const char *group_name, H5_inde
* \see H5Literate()
*
*/
-H5_DLL herr_t H5Lvisit2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate2_t op,
- void *op_data);
+H5_DLL herr_t H5Lvisit2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate2_t op,
+ void *op_data);
/**
* \ingroup TRAV
*
@@ -1178,9 +1175,8 @@ H5_DLL herr_t H5Lvisit2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t orde
* \since 1.12.0
*
*/
-H5_DLL herr_t H5Lvisit_by_name2(hid_t loc_id, const char *group_name, H5_index_t idx_type,
- H5_iter_order_t order, H5L_iterate2_t op, void *op_data, hid_t lapl_id);
-
+H5_DLL herr_t H5Lvisit_by_name2(hid_t loc_id, const char *group_name, H5_index_t idx_type,
+ H5_iter_order_t order, H5L_iterate2_t op, void *op_data, hid_t lapl_id);
/* UD link functions */
/**
* \ingroup H5L
@@ -1611,13 +1607,13 @@ H5_DLL herr_t H5Lcreate_external(const char *file_name, const char *obj_name, hi
/* Information struct for link (for H5Lget_info1/H5Lget_info_by_idx1) */
//! [H5L_info1_t_snip]
typedef struct {
- H5L_type_t type; /**< Type of link */
- hbool_t corder_valid; /**< Indicate if creation order is valid */
- int64_t corder; /**< Creation order */
- H5T_cset_t cset; /**< Character set of link name */
+ H5L_type_t type; /**< Type of link */
+ hbool_t corder_valid; /**< Indicate if creation order is valid */
+ int64_t corder; /**< Creation order */
+ H5T_cset_t cset; /**< Character set of link name */
union {
- haddr_t address; /**< Address hard link points to */
- size_t val_size; /**< Size of a soft link or UD link value */
+ haddr_t address; /**< Address hard link points to */
+ size_t val_size; /**< Size of a soft link or UD link value */
} u;
} H5L_info1_t;
//! [H5L_info1_t_snip]
@@ -1628,21 +1624,20 @@ typedef hid_t (*H5L_traverse_0_func_t)(const char *link_name, hid_t cur_group, c
/** User-defined link types */
typedef struct {
- int version; /**< Version number of this struct */
- H5L_type_t id; /**< Link type ID */
- const char *comment; /**< Comment for debugging */
- H5L_create_func_t create_func; /**< Callback during link creation */
- H5L_move_func_t move_func; /**< Callback after moving link */
- H5L_copy_func_t copy_func; /**< Callback after copying link */
- H5L_traverse_0_func_t trav_func; /**< Callback during link traversal */
- H5L_delete_func_t del_func; /**< Callback for link deletion */
- H5L_query_func_t query_func; /**< Callback for queries */
+ int version; /**< Version number of this struct */
+ H5L_type_t id; /**< Link type ID */
+ const char * comment; /**< Comment for debugging */
+ H5L_create_func_t create_func; /**< Callback during link creation */
+ H5L_move_func_t move_func; /**< Callback after moving link */
+ H5L_copy_func_t copy_func; /**< Callback after copying link */
+ H5L_traverse_0_func_t trav_func; /**< Callback during link traversal */
+ H5L_delete_func_t del_func; /**< Callback for link deletion */
+ H5L_query_func_t query_func; /**< Callback for queries */
} H5L_class_0_t;
/** Prototype for H5Literate1() / H5Literate_by_name1() operator */
//! [H5L_iterate1_t_snip]
-typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_t *info,
- void *op_data);
+typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_t *info, void *op_data);
//! [H5L_iterate1_t_snip]
/* Function prototypes */
generated by cgit v0.12 at 2024-11-01 01:40:07 (GMT)