Queries the value of a property
Procedure:
H5P_GET ( plid, name, value )
Signature:
herr_t H5Pget(
hid_t plid,
const char *name,
void *value
)
Fortran90 Interface: h5pget_f
Signature:
SUBROUTINE h5pget_f(plid, name, value, hdferr)
INTEGER(HID_T) , INTENT(IN) :: plid
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE , INTENT(OUT) :: value
INTEGER , INTENT(OUT) :: hdferr
Inputs:
prp_id - Property list identifier to modify
name - Name of property to get
value - Property value, supported types are:
INTEGER
REAL
DOUBLE PRECISION
CHARACTER(LEN=*)
Outputs:
hdferr - Returns 0 if successful and -1 if fails
Fortran2003 Interface: h5pget_f
Signature:
SUBROUTINE h5pget_f(plid, name, value, hdferr)
INTEGER(HID_T) , INTENT(IN) :: plid
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(C_PTR) , INTENT(OUT) :: value
INTEGER , INTENT(OUT) :: hdferr
Inputs:
prp_id - Property list identifier to modify
name - Name of property to get
value - Pointer to a location to which to copy the value of
the property
Outputs:
hdferr - Returns 0 if successful and -1 if fails
Parameters:
hid_t plid | IN: Identifier of the property list to query |
const char *name | IN: Name of property to query |
void *value | OUT: Pointer to a location to which to copy the value of of the property |
Description:
H5P_GET retrieves a copy of the value for a property in a property list. If there is a get callback routine registered for this property, the copy of the value of the property will first be passed to that routine and any changes to the copy of the value will be used when returning the property value from this routine.
This routine may be called for zero-sized properties with the value set to NULL. The get routine will be called with a NULL value if the callback exists.
The property name must exist or this routine will fail.
If the get callback routine returns an error, value will not be modified.
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 | 11:31 AM
