Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_FAMILY_OFFSET

Retrieves a data offset from the file access property list

Procedure:

H5P_GET_FAMILY_OFFSET ( fapl_id, offset )

Signature:

herr_t H5Pget_family_offset (
                        hid_t fapl_id,
                        hsize_t *offset
    )
  

Parameters:
hid_t fapl_idIN: File access property list identifier.
hsize_t *offset    OUT: Offset in bytes within the HDF5 file.

Description:

H5P_GET_FAMILY_OFFSET retrieves the value of offset from the file access property list fapl_id so that the user application can retrieve a file handle for low-level access to a particular member of a family of files. The file handle is retrieved with a separate call to H5Fget_vfd_handle (or, in special circumstances, to H5FDget_vfd_handle; see Virtual File Layer and List of VFL Functions in HDF5 Technical Notes).

Returns:

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

Example:

Coming Soon!

History:
Release    C
1.6.0Function introduced in this release.

--- Last Modified: December 04, 2017 | 08:19 AM