H5P_GET_FILE_IMAGE_CALLBACKS

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Retrieves callback routines for working with file images

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5P_GET_FILE_IMAGE_CALLBACKS ( fapl_id, callbacks_ptr )

Note

Motivation: H5P_SET_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

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-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>

Comment (Hide)

HTML Wrap

class	hdf-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">Replace this text with the Fortran function signature</code></pre>

HTML Wrap

class	hdf-togglebox hdf-cxx hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-cxx

HTML
<pre><code class="language-cpp">Replace this text with the C++ Function Signature</code></pre>

HTML Wrap

class	hdf-togglebox hdf-java hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-java

HTML
<pre><code class="language-java">Replace this text with the JAVA Function Signature</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t fapl_id IN: File access property list identifier

H5_file_image_callbacks_t *callbacks_ptr

IN/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

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	example

Example:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	examples/h5_subset.c
showLineNumbers	true
lineStart	32
progLang	cpp
lineEnd	42
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	fortran/examples/compound.f90
showLineNumbers	true
lineStart	25
progLang	plain
lineEnd	35
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap

class	hdf-togglebox hdf-cxx hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	c++/examples/create.cpp
showLineNumbers	true
lineStart	33
progLang	cpp
lineEnd	43
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap

class	hdf-togglebox hdf-java hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	java/examples/datasets/H5Ex_D_Chunk.java
showLineNumbers	true
lineStart	32
progLang	java
lineEnd	42
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

Release	Change
1.8.9	C function introduced in this release.

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect