Recursively visits all links starting from a specified group

H5L_VISIT1 is a recursive iteration function to visit all links in and below a group in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those links or a dynamically selected subset. For non-recursive iteration across the members of a group, see H5L_ITERATE1 .

The group serving as the root of the iteration is specified by its group or file identifier, group_id.

Two parameters are used to establish the iteration: idx_type and order.

idx_type specifies the index to be used. If the links have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly. Valid values include the following:

Note that the index type passed in idx_type is a best effort setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alpha-numeric order by name, or name order. (Name order is the native order used by the HDF5 library and is always available.)

order specifies the order in which objects are to be inspected along the index specified in index_type. Valid values include the following:

The prototype of the callback function op is as follows (as defined in the source code file H5Lpublic.h):

typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_t *info, void *op_data);

The parameters of this callback function have the following values or meanings:

The H5L_info1_t struct is defined (in H5Lpublic.h) as follows:

    typedef struct {
        H5L_type_t     type;         /* Type of link                   */
        hbool_t        corder_valid; /* Indicates whether 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 soft link or           */
                                     /* user-defined link value        */
        } u;
    } H5L_info1_t;

The possible return values from the callback function, and the effect of each, are as follows:

• Zero causes the visit iterator to continue, returning zero when all group members have been processed.
• A positive value causes the visit iterator to immediately return that positive value, indicating short-circuit success.
• A negative value causes the visit iterator to immediately return that value, indicating failure.

The H5L_VISIT1 op_data parameter is a user-defined pointer to the data required to process links in the course of the iteration. This pointer is passed back to each step of the iteration in the op callback function’s op_data parameter.  

H5L_VISIT1 and H5O_VISIT1 are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires.

On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.

On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.