H5Pget_file_image
(
hid_t fapl_id
,
void **buf_ptr_ptr
,
size_t *buf_len_ptr
)
H5Pget_file_image
and other HDF5 elements are
used to load an image of an HDF5 file into system memory
and to open that image as a regular HDF5 file.
An application can then work with the file without the overhead
of disk I/O.
Tthe “See Also” section below provides links to individual elements of HDF5 file image operations feature set.
H5Pget_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, H5Pget_file_image
will use them when allocating and loading the buffer
to return to the application (see
H5Sset_file_image_callbacks
).
If file image callbacks are not defined, the function will use
malloc
and memcpy
.
When malloc
and memcpy
are used,
it is the caller’s responsibility to discard the returned buffer
with a call to free
.
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 H5Pset_file_image_callbacks
)
or with the appropriate method if file image callbacks have been set.
hid_t fapl_id
| IN: File access property list identifier. | |
void **buf_ptr_ptr
| IN/OUT: On input,
NULL or a pointer to a void* .
On successful return,
if | |
size_t *buf_len_ptr
| IN/OUT: On input,
NULL or a pointer to size_t .
On successful return,
if |
H5LTopen_file_image
H5Fget_file_image
H5Pset_file_image
H5Pset_file_image_callbacks
H5Pget_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
|
Release | Change |
1.8.9 | C function introduced in this release. |