Determines whether a class of user-defined links is registered
Procedure:
H5L_IS_REGISTERED(link_cls_id)
Signature:
htri_t H5Lis_registered( H5L_type_t link_cls_id )
SUBROUTINE H5Lis_registered_f(link_cls_id, registered, hdferr)
IMPLICIT NONE
INTEGER, INTENT(IN) :: link_cls_id ! User-defined link class identifier
LOGICAL, INTENT(OUT) :: registered ! .TRUE. - if the link class is registered
! .FALSE. - if it is unregistered
INTEGER, INTENT(OUT) :: hdferr ! Error code:
! 0 on success and -1 on failure
END SUBROUTINE H5Lis_registered_f
Parameters:
H5L_type_t link_cls_id | IN: User-defined link class identifier |
Description:
H5L_IS_REGISTERED tests whether a user-defined link class is currently registered, either by the HDF5 library or by the user through the use of H5L_REGISTER .
A link class must be registered to create new links of that type or to traverse existing links of that type.
Returns:
Returns a positive value if the link class has been registered.
Returns 0 if the link class has not been registered.
Returns a negative value if the identifier is not a valid user-defined class identifier or if the function fails.
Example:
History:
| Release | Change |
|---|
| 1.8.0 | Function introduced in this release. |
--- Last Modified: April 25, 2019 | 12:49 PM
