#####

Hello, and welcome to this template! To fill this out, simply scroll down and fill in all information in each box following each subsequent RED comment text box (like this one), and ignore everything else! Also, there's no need to remove these giant red text box comments – they will not show up on the page!

If you are confused about anything, or can think of a helpful comment to add to this template, please submit a ticket to the SUPPORTAL JIRA project. Thanks!

#####

    <input type="checkbox" />   
    <span></span>
    <span></span>
    <span></span>

Summary

 Description

 Example

JAVA

FORTRAN

C++

C

 

#####

Add a short (not more than 80 characters) summary of this function below.

#####

Iterates through links in a group

Procedure:

#####

Add the GENERIC, language-agnostic procedure here.

#####

H5L_ITERATE(group, index_type, order, position, op, ctx)

Signature:

#####

Add the C function signature inside the following HTML macro box, retaining the existing HTML tags (which apply language-specific code highlighting).

#####

<pre><code class="language-c">herr_t H5Literate
(
  hid_t           group,
  H5_index_t      index_type,
  H5_iter_order_t order,
  hsize_t*        position,
  H5L_iterate_t   op,
  void*           ctx
)</code>
</pre>

#####  

Add the FORTRAN function signature inside the following HTML macro box, retaining the existing HTML tags (which apply language-specific code highlighting).

Note: If there is NO FORTRAN implementation of this function, remove the entire HTML WRAP that this comment resides in (the one with 'hdf-fortran' as one of its classes). To do so, left click on the macro and click 'Remove'.

  #####

<pre><code class="language-fortran">SUBROUTINE h5literate_f(group,index_type, order, position,
           op, ctx, return_value, hdferr)
    INTEGER(HID_T) , INTENT(IN) :: group
    INTEGER , INTENT(IN) :: index_type
    INTEGER , INTENT(IN) :: order
    INTEGER(HSIZE_T), INTENT(INOUT) :: position
    TYPE(C_FUNPTR) , INTENT(IN) :: op
    TYPE(C_PTR) , INTENT(IN) :: ctx
    INTEGER , INTENT(OUT) :: return_value
    INTEGER , INTENT(OUT) :: hdferr</code></pre>

Parameters:

#####

Add the list of parameters to this function here.

#####

NameModeKindDescription
groupINhandleGroup identifier
index_typeINchoiceIndex for iteration order
orderINchoiceTraversal order
positionINOUTintegerIteration position
opINdelegateUser-defined operator
ctxINOUTopaqueUser-supplied context
Description:

#####

Describe the behavior of this function in as concise of terms as possible.

Use the "Include Content" macro to display information inline that exists on another Confluence page (to avoid duplication of information).

Use the "Info" macro to provide links to other relevant information on Confluence.

Use the "Warning" macro to draw the user's attention to potential pitfalls, deficiencies, or gotchas they should be aware of while using this function.

Use the "Tip" macro to emphasize other important information that should be highlighted on the page.

#####

H5L_ITERATE iterates through the links in group, in order along index_type, using opH5L_ITERATE does not recursively follow links into subgroups of group.

The choices for index_type are:

NameMeaning
H5_INDEX_NAMELexicographic order
H5_INDEX_CRT_ORDERCreation order

The choices for order are:

Name

Meaning

H5_ITER_INCIncreasing order
H5_ITER_DECDecreasing order
H5_ITER_NATIVEFastest order

If the links have not been indexed by index_type, they will be sorted by index_type before the iteration.

position tracks the iteration and allows an interrupted iteration to be resumed.

op is invoked for each link encounter:

ctx is passed to and from each iteration and can be used to supply or aggregate information across iterations.

The behavior of H5L_ITERATE is undefined if the link membership of group changes during the iteration. This does not limit the ability to change link destinations while iterating, but caution is advised.

For recursive behavior, see the following:

H5Lvisit

H5Lvisit_by_name

H5Ovisit

H5Ovisit_by_name

Returns:

#####

List the return values of this function, and their meanings, in this section.

#####

On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.

On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator. 

Example:

#####

Provide an example of this function in C in the following HTML box, retaining the existing HTML tags (which apply language-specific code highlighting).

OR – replace the HTML box with the 'Bitbucket server file' macro to display a file that's stored in a public Bitbucket repo.  

#####

#####

Provide an example of this function in FORTRAN in the following HTML box, retaining the existing HTML tags (which apply language-specific code highlighting).

OR – replace the HTML box with the 'Bitbucket server file' macro to display a file that's stored in a public Bitbucket repo.

Note: If there is NO FORTRAN implementation of this function, remove the entire HTML WRAP that this comment resides in (the one with 'hdf-fortran' as one of its classes). To do so, left click on the macro and click 'Remove'.

#####

History:

#####

List the function's change history here.

#####

ReleaseChange
1.8.8Fortran subroutine added.
1.8.0C function introduced.