Opens an HDF5 file image in memory.
Procedure:
H5LT_OPEN_FILE_IMAGE(buf_ptr, buf_size, flags)
Signature:
hid_t H5LTopen_file_image( void *buf_ptr, size_t buf_size, unsigned flags )
Parameters:
void *buf_ptr | IN: A pointer to the supplied initial image A value of NULL is invalid and will cause the function to fail. |
size_t buf_size | IN: Size of the supplied buffer A value of 0 is invalid and will cause the function to fail. |
unsigned flags | IN: Flags specifying whether to open the image read-only or read/write, whether HDF5 is to take control of the buffer, and instruction regarding releasing the buffer Valid values are: H5LT_FILE_IMAGE_OPEN_RWSpecifies opening the file image in read/write mode.Default without this flag: File image will be opened read-only.H5LT_FILE_IMAGE_DONT_COPYSpecifies to not copy the provided file image buffer; the buffer will be used directly. HDF5 will release the file image when finished.Default without this flag: Copy the file image buffer and open the copied file image.H5LT_FILE_IMAGE_DONT_RELEASESpecifies that HDF5 is not to release the buffer when the file opened withH5LTopen_file_image is closed; releasing the buffer will be left to the application.Default without this flag: HDF5 will automatically release the file image buffer after the file image is closed.This flag is valid only when used with H5LT_FILE_IMAGE_DONT_COPY. |
Description:
H5LTopen_file_image opens the HDF5 file image that is located in system memory at the address indicated by buf_ptr of size buf_size. H5LTopen_file_image opens a file image with the Core driver, H5FD_CORE.
The flags passed in flags specify whether to open the image read-only or read/write, whether HDF5 is to take control of the buffer, and instruction regarding releasing the buffer.
Returns:
Returns a file identifier if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
| 1.8.9 | C function introduced in this release. |
--- Last Modified: December 04, 2017 | 07:13 AM
