Retrieves the maximum number of link traversals
Procedure:
H5P_GET_NLINKS ( lapl_id, nlinks )
Signature:
herr_t H5Pget_nlinks(
hid_t lapl_id,
size_t *nlinks
)
Fortran90 Interface: h5pget_nlinks_f
SUBROUTINE h5pget_nlinks_f(lapl_id, nlinks, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: lapl_id
! File access property list identifier
INTEGER(SIZE_T), INTENT(OUT) :: nlinks
! Maximum number of links to traverse
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5pget_nlinks_f
Parameters:
hid_t fapl_id | IN: File access property list identifier |
size_t *nlinks | OUT: Maximum number of links to traverse |
Description:
H5P_GET_NLINKS retrieves the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is retrieved from the link access property list lapl_id.
The limit on the number soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.8.0 | Function introduced in this release. |
--- Last Modified: June 12, 2019 | 02:05 PM
