Page tree

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

Sets an initial file image in a memory buffer

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

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

H5P_SET_FILE_IMAGE ( fapl_id, buf_ptr, buf_len )

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 H5Pset_file_image(
            hid_t fapl_id,
            void *buf_ptr,
            size_t buf_len
        )</code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

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

HTML
<pre><code class="language-fortran">Fortran2003 Interface: h5pset_file_image_f
    
Signature:
  SUBROUTINE h5pset_file_image_f(fapl_id, buf_ptr, buf_len, hdferr)
    USE iso_c_binding
    IMPLICIT NONE
    INTEGER(HID_T) , INTENT(IN)  :: fapl_id
    TYPE(C_PTR)    , INTENT(IN)  :: buf_ptr
    INTEGER(SIZE_T), INTENT(IN)  :: buf_len
    INTEGER        , INTENT(OUT) :: hdferr

Inputs:
  fapl_id - File access property list identifier
  buf_ptr - Pointer to the initial file image, 
            or C_NULL_PTR if no initial file image is desired
  buf_len - Size of the supplied buffer, or 0 (zero) if no initial image is desired

Outputs:
  hdferr  - Returns 0 if successful and -1 if fails
</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t fapl_idIN: File access property list identifier
void *buf_ptrIN: Pointer to the initial file image, or NULL if no initial file image is desired
size_t buf_lenIN: Size of the supplied buffer, or 0 (zero) if no initial image is desired

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5P_SET_FILE_IMAGE allows an application to provide a file image to be used as the initial contents of a file. Calling H5P_SET_FILE_IMAGE makes a copy of the buffer specified in buf_ptr of size buf_len.

Motivation: H5P_SET_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 HDF5 File Image Operations” 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 non-negative value if successful; otherwise returns a negative value.

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment
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

See Also:
Info

 

H5LT_OPEN_FILE_IMAGE

H5F_GET_FILE_IMAGE

H5P_GET_FILE_IMAGE

H5P_SET_FILE_IMAGE_CALLBACKS

H5P_GET_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
AnchorNamehistory

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