- Created by Barbara Jones, last modified on Aug 06, 2019
Jump to ...
Switch language ...
Retrieves a copy of the file image designated as the initial content and structure of a file
H5P_GET_FILE_IMAGE ( fapl_id, buf_ptr_ptr, buf_len_ptr )
herr_t H5Pget_file_image( hid_t fapl_id, void **buf_ptr_ptr, size_t *buf_len_ptr )
Fortran2003 Interface: h5pget_file_image_f Signature: SUBROUTINE h5pget_file_image_f(fapl_id, buf_ptr, buf_len_ptr, hdferr) USE iso_c_binding IMPLICIT NONE INTEGER(HID_T) , INTENT(IN) :: fapl_id TYPE(C_PTR) , INTENT(OUT), DIMENSION(*) :: buf_ptr INTEGER(SIZE_T), INTENT(OUT) :: buf_len_ptr INTEGER , INTENT(OUT) :: hdferr Inputs: fapl_id - File access property list identifier. Outputs: buf_ptr - Will hold either a C_NULL_PTR or a scalar of type c_loc. If buf_ptr is not C_NULL_PTR, on successful return, buf_ptr shall contain a C pointer to a copy of the initial image provided in the last call to H5Pset_file_image_f for the supplied fapl_id, or buf_ptr shall contain a C_NULL_PTR if there is no initial image set. buf_len_ptr - Contains the value of the buffer parameter for the initial image in the supplied fapl_id. The value will be 0 if no initial image is set. hdferr - Returns 0 if successful and -1 if fails
|hid_t ||IN: File access property list identifier|
|void **||IN/OUT: On input, |
On successful return, if
|size_t *||IN/OUT: On input, |
On successful return, if
H5P_GET_FILE_IMAGE allows an application to retrieve a copy of the file image designated for a VFD to use as the initial contents of a file.
If file image callbacks are defined, H5P_GET_FILE_IMAGE will use them when allocating and loading the buffer to return to the application (see H5P_SET_FILE_IMAGE_CALLBACKS). If file image callbacks are not defined, the function will use
memcpy are used, it is the caller’s responsibility to discard the returned buffer with a call to
It is the responsibility of the calling application to free the buffer whose address is returned in
buf_ptr_ptr. This can be accomplished with
free if file image callbacks have not been set (see H5P_SET_FILE_IMAGE_CALLBACKS) or with the appropriate method if file image callbacks have been set.
HDF5 File Image Operations in Advanced Topics in HDF5
Returns a non-negative value if successful; otherwise returns a negative value.
|1.8.13||Fortran subroutine added in this release.|
|1.8.9||C function introduced in this release.|
--- Last Modified: August 06, 2019 | 01:02 PM