Last modified: 13 April 2012
Name: H5Pset_file_image
Signature:
herr_t H5Pset_file_image( hid_t fapl_id, void *buf_ptr, size_t buf_len )

Purpose:
Sets an initial file image in a memory buffer.

Motivation:
H5Pset_file_image 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:
H5Pset_file_image allows an application to provide a file image to be used as the initial contents of a file. Calling H5Pset_file_image makes a copy of the buffer specified in buf_ptr of size buf_len.

Parameters:
hid_t fapl_id      IN: File access property list identifier
void *buf_ptr   IN: Pointer to the initial file image, or NULL if no initial file image is desired
size_t buf_len   IN: Size of the supplied buffer, or 0 (zero) if no initial image is desired

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

See Also:
H5LTopen_file_image
 
H5Fget_file_image
 
H5Pget_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

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