Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_MCDT_SEARCH_CB

Sets the callback function that H5O_COPY will invoke before searching the entire destination file for a matching committed datatype

Procedure:

H5P_SET_MCDT_SEARCH_CB ( ocpypl_id, func, op_data )

Signature:

herr_t H5Pset_mcdt_search_cb(
            hid_t ocpypl_id,
            H5O_mcdt_search_cb_t func,
            void *op_data
        )

  

NONE

Parameters:
id_t ocpypl_idIN: Object copy property list identifier
H5O_mcdt_search_cb_t funcIN: User-defined callback function
void *op_dataIN: User-defined input data for the callback function

Motivation:
H5P_SET_MCDT_SEARCH_CB provides the means to define a callback function. An application can then use that callback to take an additional action before the default search of all committed datatypes in the destination file or to take an action that replaces the default search. This mechanism is intended to improve performance when the global search might take a long time.
Description:

H5P_SET_MCDT_SEARCH_CB allows an application to set a callback function, func, that will be invoked before searching the destination file for a matching committed datatype. The default, global search process is described in H5P_ADD_MERGE_COMMITTED_DTYPE_PATH.

The callback function must conform to the H5O_mcdt_search_cb_t prototype and will return an instruction for one of the following actions:

  • Continue the search for a matching committed datatype in the destination file.
  • Discontinue the search for a matching committed datatype. H5O_COPY will then apply the default behavior of creating an anonymous committed datatype.
  • Abort the copy operation and exit H5O_COPY.

If the callback function return value causes H5O_COPY to abort, the destination file may be left in an inconsistent or corrupted state.

Programming Note for C++ Developers Using C Functions:

If a C routine that takes a function pointer as an argument is called from within C++ code, the C routine should be returned from normally.

Examples of this kind of routine include callbacks such as H5P_SET_ELINK_CB and H5P_SET_TYPE_CONV_CB and functions such as H5T_CONVERT and H5E_WALK2.

Exiting the routine in its normal fashion allows the HDF5 C Library to clean up its work properly. In other words, if the C++ application jumps out of the routine back to the C++ “catch” statement, the library is not given the opportunity to close any temporary data structures that were set up when the routine was called. The C++ application should save some state as the routine is started so that any problem that occurs might be diagnosed.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Failure Modes:

H5P_SET_MCDT_SEARCH_CB will fail if the object copy property list is invalid.

Example Usage:
This example defines a callback function in the object copy property list.
/* The user-defined callback function */
static H5O_mcdt_search_ret_t
mcdt_search_cb(void *_udata)
{
    H5O_mcdt_search_ret_t action = *((H5O_mcdt_search_ret_t *)_udata);

    return(action);
}

int main(void) {
    hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY);

    /* Enable the merging committed datatype feature. */
    H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG);

    /* Add a path to search for a matching committed datatype. */
    H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA");

    /* 
     * Set the callback function to discontinue the global search
     * if H5Ocopy cannot find a matching committed datatype from the 
     * above suggested path.
     */
    action = H5O_MCDT_SEARCH_STOP;
    H5Pset_mcdt_search_cb(ocpypl_id, mcdt_search_cb, &action);
    H5Ocopy(...ocpypl_id...);
    ...
    ...
}

 

History:
Release    Change
1.8.9C function introduced in this release.

--- Last Modified: January 05, 2018 | 03:26 PM