Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column

Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Opens an HDF5 file image in memory.

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5LT_OPEN_FILE_IMAGE (buf_ptr, buf_size, flags)

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">hid_t H5LTopen_file_image( void *buf_ptr, size_t buf_size, unsigned flags )</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
void *buf_ptrIN: A pointer to the supplied initial image

A value of NULL is invalid and will cause the function to fail.

size_t buf_sizeIN: Size of the supplied buffer

A value of 0 is invalid and will cause the function to fail.

unsigned flagsIN: 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.

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section
Info

Motivation:

H5LTopen

H5LT_

file_image 

OPEN_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.

 

H5LTopen

H5LT_

file_image 

OPEN_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

H5LT_

file_image 

OPEN_FILE_IMAGEopens 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.

Info

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.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns a file identifier if successful; otherwise returns a negative value.

Warning

Failure Modes:

H5LTopen

H5LT_

file_image 
Comment (Hide)

OPEN_FILE_IMAGE will fail if either buf_ptr is NULL or buf_size equals 0 (zero).

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepath

examples

hl/

h5_subset

test/test_file_image.c
showLineNumberstrue
lineStart

32

197
progLang

cpp

plain
lineEnd

42

198
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Comment (Hide)

 

 

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.8.9C function introduced in this release.