Sets a property list value
Procedure:
H5P_SET ( plid, name, value )
Signature:
herr_t H5Pset(
hid_t plid,
const char *name,
void *value)
)
Fortran90 Interface: h5pset_f
Signature:
SUBROUTINE h5pset_f(plid, name, value, hdferr)
INTEGER(HID_T) , INTENT(IN) :: plid
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE , INTENT(IN) :: value
INTEGER , INTENT(OUT) :: hdferr
Inputs:
prp_id - Property list identifier to modify
name - Name of property to modify
value - Property value, supported types are:
INTEGER
REAL
DOUBLE PRECISION
CHARACTER(LEN=*)
Outputs:
hdferr - Returns 0 if successful and -1 if fails
Fortran2003 Interface: h5pset_f
Signature:
SUBROUTINE h5pset_f(plid, name, value, hdferr)
INTEGER(HID_T) , INTENT(IN) :: plid
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(C_PTR) , INTENT(IN) :: value
INTEGER , INTENT(OUT) :: hdferr
Inputs:
prp_id - Property list identifier to modify
name - Name of property to modify
value - Pointer to value to set the property to
Outputs:
hdferr - Returns 0 if successful and -1 if fails
Parameters:
hid_t plid; | IN: Property list identifier to modify |
const char *name; | IN: Name of property to modify |
void *value; | IN: Pointer to value to set the property to |
Description:
H5P_SET sets a new value for a property in a property list. If there is a set callback routine registered for this property, the value will be passed to that routine and any changes to the value will be used when setting the property value. The information pointed to by the value pointer (possibly modified by the set callback) is copied into the property list value and may be changed by the application making the H5P_SET call without affecting the property value.
The property name must exist or this routine will fail.
If the set callback routine returns an error, the property value will not be modified.
This routine may not be called for zero-sized properties and will return an error in that case.
Returns:
Success: a non-negative value Failure: a negative value
Example:
History:
| Release | Change |
|---|
| 1.8.8 | Fortran updated to Fortran2003. |
--- Last Modified: August 12, 2019 | 12:25 PM
