When a file is created or opened for writing using the core virtual file driver (VFD) with the backing store option turned on, the VFD can be configured to track changes to the file and only write out the modified bytes. To avoid a large number of small writes, the changes can be aggregated into pages of a user-specified size. The core VFD is also known as the memory VFD. The driver identifier is H5FD_CORE.
This function is only for use with the core VFD and must be used after the call to H5P_SET_FAPL_CORE. It is an error to use this function with any other VFD.
This function only applies to the backing store write operation which typically occurs when the file is flushed or closed. This function has no relationship to the increment parameter passed to H5P_SET_FAPL_CORE.
For optimum performance, the page_size parameter should be a power of two.
Returns a non-negative value if successful. Otherwise returns a negative value.