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

Retrieves callback routines for working with file images

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

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

H5P_GET_FILE_IMAGE_CALLBACKS ( fapl_id, callbacks_ptr )

Note

Motivation: H5P_GET_FILE_IMAGE_CALLBACKS 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.

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">herr_t H5Pget_file_image_callbacks(
            hid_t fapl_id,
            H5_file_image_callbacks_t *callbacks_ptr
        )

  </code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t fapl_idIN: File access property list identifier
 H5_file_image_callbacks_t *callbacks_ptrIN/OUT: Pointer to the instance of the H5_file_image_callbacks_t struct in which the callback routines are to be returned

Struct fields must be initialized to NULL before the call is made.

Struct field contents upon return will match those passed in in the last H5P_SET_FILE_IMAGE_CALLBACKS call for the file access property list fapl_id.

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5P_GET_FILE_IMAGE_CALLBACKS retrieves the callback routines set for working with file images opened with the file access property list fapl_id.

The callbacks must have been previously set with H5P_SET_FILE_IMAGE_CALLBACKS in the file access property list.

Upon the successful return of H5P_SET_FILE_IMAGE_CALLBACKS, the fields in the instance of the H5_file_image_callbacks_t struct pointed to by callbacks_ptr will contain the same values as were passed in the most recent H5P_SET_FILE_IMAGE_CALLBACKS call for the file access property list fapl_id.

See Also:
HTML Wrap
classhdf-rm-section
Info

 

H5LT_OPEN_FILE_IMAGE

H5F_GET_FILE_IMAGE

H5P_SET_FILE_IMAGE

H5P_GET_FILE_IMAGE

H5P_GETSET_FILE_IMAGE_CALLBACKS

 

HDF5 File Image Operations in Advanced Topics in HDF5

 

Within H5P_SET_FILE_IMAGE_CALLBACKS:

Callback struct   H5_file_image_callbacks_t
Callback ENUM   H5_file_image_op_t

 

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

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.