SUBROUTINE h5literate_by_name_f(loc_id, group_name, index_type, &
order, idx, op, op_data, return_value, hdferr, lapl_id)
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*) :: group_name
INTEGER, INTENT(IN) :: index_type
INTEGER, INTENT(IN) :: order
INTEGER(HSIZE_T), INTENT(INOUT) :: idx
TYPE(C_FUNPTR):: op
TYPE(C_PTR) :: op_data
INTEGER, INTENT(OUT) :: return_value
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id
Inputs:
loc_id - File or group identifier specifying location of subject group
group_name - Name of subject group
index_type - Type of index which determines the order:
H5_INDEX_NAME_F - Alpha-numeric index on name
H5_INDEX_CRT_ORDER_F - Index on creation order
order - Order within index:
H5_ITER_INC_F - Increasing order
H5_ITER_DEC_F - Decreasing order
H5_ITER_NATIVE_F - Fastest available order
idx - IN: Iteration position at which to start
op - Callback function passing data regarding the link to the
calling application
op_data - User-defined pointer to data required by the application for
its processing of the link
Outputs:
idx - OUT: Position at which an interrupted iteration
may be restarted
return_value - Success: The return value of the first operator that
returns non-zero, or zero if all members were
processed with no operator returning non-zero.
Failure: Negative if something goes wrong within the
library, or the negative value returned by one
of the operators.
hdferr - Returns 0 if successful and -1 if fails
Optional parameters:
lapl_id - Link access property list