Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column

Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar

rm-purpose
HTML Wrap
classhdf-
print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Garbage collects on all free-lists of all types.

 

HTML Wrap
classhdf-rm-content-block

hdf-rm-anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5_GARBAGE_COLLECT(void)

Hdf rm anchor
AnchorNamesignature

Signature:
SUBROUTINE
HTML Wrap
classhdf-rm-section
Comment (Hide)

Edit each block below with the corresponding language signature for this function.

If there is no implementation for a given language, simply remove the entire block (right click --> Remove) for that language signature.

Hdf rm c signature
herr_t H5garbage_collect(void
Hdf rm fortran signature
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5garbage_collect
(
    void
) </code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">SUBROUTINE h5garbage_collect_f(error)
    INTEGER, INTENT(OUT) :: 
error
error</code></pre>

hdf-rm-anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section

None.

hdf-rm-
descriptionH5garbage_collect walks
Anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5_GARBAGE_COLLECT walks through all garbage collection routines of the library, freeing any unused memory.

It is not required

that H5garbage_collect be

that H5_GARBAGE_COLLECT be called at any particular time; it is only necessary in certain situations where the application has performed actions that cause the library to allocate many objects. The application should

call H5garbage_collect if

call H5_GARBAGE_COLLECT if it eventually releases those objects and wants to reduce the memory used by the library from the peak usage required.

The library automatically garbage collects all the free lists when the application ends.

hdf-rm-
returnvals
Anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns a non-negative value if successful; otherwise returns a negative value.

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Comment (Hide)

Edit each Bitbucket server macro below to point to example code hosted in Bitbucket.

If there is no implementation for a given language, simply remove the 'HTML Wrap' that the Bitbucket Server file macro resides in for that language.

If there IS an implemntation for a given language, but it's missing an example, replace the 'Bitbucket server file' macro with the text, "Example Coming Soon".

Coming soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
class

hdf-

togglebox hdf-cxx hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathc++/examples/create.cpp
showLineNumberstrue
lineStart33
progLangcpp
lineEnd43
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

rm-anchor
AnchorNamehistory

History:
togglebox hdf-java hdf-togglebox-hidden
HTML Wrap
classhdf-

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathjava/examples/datasets/H5Ex_D_Chunk.java
showLineNumberstrue
lineStart32
progLangjava
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

hdf-rm-history
rm-section
Release    Fortran90
1.4.5Function introduced in this release.
1.8.8Fortran subroutine updated in this release.