Determines whether an identifier is valid
Procedure:
Signature:
htri_t H5Iis_valid( hid_t obj_id )
SUBROUTINE h5iis_valid_f(id, valid, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: id ! Identifier
LOGICAL, INTENT(OUT) :: valid ! Status of id as
! valid (.true.) or invalid (.false.)
INTEGER, INTENT(OUT) :: hdferr ! Error code: 0 on success, and -1 on failure
END SUBROUTINE h5iis_valid_f
Parameters:
hid_t obj_id | IN: Identifier to validate |
Description:
H5I_IS_VALID determines whether the identifier obj_id is valid.
Valid identifiers are those that have been obtained by an application and can still be used to access the original target. Examples of invalid identifiers include:
- Out of range values: negative, for example
- Previously-valid identifiers that have been released: for example, a dataset identifier for which the dataset has been closed
H5I_IS_VALID can be used with any type of identifier: object identifier, property list identifier, attribute identifier, error message identifier, etc. When necessary, a call to H5I_GET_TYPE can determine the type of the object that obj_id identifies.
Returns:
Returns a positive value if obj_id is valid.
Returns 0 if obj_id is invalid.
Returns a negative value when the function fails.
Example:
History:
| Release | Change |
|---|
| 1.8.3 | C function introduced in this release. |
--- Last Modified: April 25, 2019 | 12:17 PM
