Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_PRESERVE

Sets the dataset transfer property list status to 1 (TRUE) or 0 (FALSE) (DEPRECATED)

This function is deprecated as it no longer has any effect; compound datatype field preservation is now core functionality in the HDF5 library.

Procedure:

H5P_SET_PRESERVE (plist, status )

Signature:

herr_t H5Pset_preserve(hid_t plist,
        hbool_t status
        )
  

Fortran90 Interface: h5pset_preserve_f
    
SUBROUTINE h5pset_preserve_f(prp_id, flag, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id   ! Dataset transfer property 
                                         ! list identifier 
  LOGICAL, INTENT(IN)        :: flag     ! Status for the dataset 
                                         ! transfer property list 
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pset_preserve_f
	

Parameters:
hid_t plistIN: Identifier for the dataset transfer property list
hbool_t status    IN: Status of for the dataset transfer property list (TRUE/FALSE)

Description:
H5P_SET_PRESERVE sets the dataset transfer property list status to 1 (TRUE) or 0 (FALSE).

When reading or writing compound datatypes and the destination is partially initialized and the read/write is intended to initialize the other members, one must set this property to TRUE. Otherwise the I/O pipeline treats the destination datapoints as completely uninitialized.

Returns:

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

Example:

Coming Soon!

History:
Release    Fortran90
1.6.0The flag parameter has changed from INTEGER to LOGICAL to better match the C API.

--- Last Modified: January 03, 2018 | 08:51 AM