H5P_GET_FILE_IMAGE_CALLBACKS
Retrieves callback routines for working with file images
Procedure:
H5P_GET_FILE_IMAGE_CALLBACKS ( fapl_id, callbacks_ptr )
Signature:
herr_t H5Pget_file_image_callbacks(
hid_t fapl_id,
H5_file_image_callbacks_t *callbacks_ptr
)
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 returnedStruct fields must be initialized to NULL before the call is made. Struct field contents upon return will match those passed in in the last H5P_SET_FILE_IMAGE_CALLBACKS call for the file access property list fapl_id . |
Description:
H5P_GET_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 H5P_SET_FILE_IMAGE_CALLBACKS in the file access property list.
Upon the successful return of H5P_SET_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 H5P_SET_FILE_IMAGE_CALLBACKS call for the file access property list fapl_id
.
See Also:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
Release | Change |
---|
1.8.9 | C function introduced in this release. |
--- Last Modified: August 06, 2019 | 01:00 PM