Last modified: 17 April 2012
Name: H5Pget_file_image_callbacks
Signature:
  herr_t `H5Pget_file_image_callbacks`( hid_t `fapl_id`, H5_file_image_callbacks_t *`callbacks_ptr` )

Purpose:
  Retrieves callback routines for working with file images.

Motivation:
  `H5Pget_file_image_callbacks` and other elements of HDF5 are used to load an image of an HDF5 file into system memory and open that image as a regular HDF5 file. An application can then use the file without the overhead of disk I/O.

Recommended Reading:
  This function is part of the file image operations feature set. It is highly recommended to study the guide “HDF5 File Image Operations” before using this feature set.

  See the “See Also” section below for links to other elements of HDF5 file image operations.

Description:
  `H5Pget_file_image_callbacks` retrieves the callback routines set for working with file images opened with the file access property list `fapl_id`.

  The callbacks must have been previously set with `H5Pset_file_image_callbacks` in the file access property list.

  Upon the successful return of `H5Pget_file_image_callbacks`, the fields in the instance of the `H5_file_image_callbacks_t` struct pointed to by `callbacks_ptr` will contain the same values as were passed in the most recent `H5Pset_file_image_callbacks` call for the file access property list `fapl_id`.

Parameters:

  hid_t `fapl_id` |  | IN: File access property list identifier.
  H5_file_image_callbacks_t *`callbacks_ptr`
  |  | IN/OUT: Pointer to the instance of the `H5_file_image_callbacks_t` struct in which the callback routines are to be returned. Struct fields must be initialized to `NULL` before the call is made. Struct field contents upon return will match those passed in in the last `H5Pset_file_image_callbacks` call for the file access property list `fapl_id`.

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

See Also:

  `H5LTopen_file_image` `H5Fget_file_image` `H5Pset_file_image` `H5Pget_file_image` `H5Pset_file_image_callbacks` | `` | “HDF5 File Image Operations” `` in Advanced Topics in HDF5 Within `H5Pset_file_image_callbacks`: Callback struct `H5_file_image_callbacks_t` Callback ENUM `H5_file_image_op_t`

History:

  Release | Change
  1.8.9 | C function introduced in this release.