summaryrefslogtreecommitdiffstats
path: root/fortran/doc/DevelGuide/src/H5_ff_f90.html
diff options
context:
space:
mode:
Diffstat (limited to 'fortran/doc/DevelGuide/src/H5_ff_f90.html')
-rw-r--r--fortran/doc/DevelGuide/src/H5_ff_f90.html269
1 files changed, 269 insertions, 0 deletions
diff --git a/fortran/doc/DevelGuide/src/H5_ff_f90.html b/fortran/doc/DevelGuide/src/H5_ff_f90.html
new file mode 100644
index 0000000..021c7c5
--- /dev/null
+++ b/fortran/doc/DevelGuide/src/H5_ff_f90.html
@@ -0,0 +1,269 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Style-Type" content="text/css" />
+<meta http-equiv="Content-type" content="text/html; charset=ISO-8859-1" />
+<link rel="stylesheet" href="../robodoc.css" type="text/css" />
+<title>./src/H5_ff.f90</title>
+<!-- Source: ./src/H5_ff.f90 -->
+</head>
+<body>
+<div id="logo">
+<a name="robo_top_of_doc">HDF5 FORTRAN Developer's Guide</a>
+</div> <!-- logo -->
+<div id="navigation">
+<a class="menuitem" href="../toc_index.html#top">Table of Contents</a>
+<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a>
+<a class="menuitem" href="../masterindex.html#top">Index</a>
+<a class="menuitem" href="../robo_functions.html#top">Functions</a>
+<a class="menuitem" href="../robo_modules.html#top">Modules</a>
+<a class="menuitem" href="../robo_procedures.html#top">Procedures</a>
+<a class="menuitem" href="../robo_subroutines.html#top">Subroutines</a>
+</div> <!-- navigation -->
+<div id="content">
+<hr />
+<a name="ROBODoc2fH5LIB"></a>
+<a name="robo53"></a><h2>H5LIB</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_modules.html#robo_top_of_doc">Modules</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> MODULE <strong>H5LIB</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> This module provides fortran specific helper functions for the HDF library
+</pre>
+<p class="item_name">USES</p>
+<pre> <a href="./H5_ff_F03_f90.html#robo54">H5LIB_PROVISIONAL</a> - This module provides helper functions for Fortran 2003
+ only features. If Fortran 2003 functions are enabled then
+ <a href="./H5_ff_F03_f90.html#robo_top_of_doc">H5_ff_F03.f90</a> is compiled, else <a href="./H5_ff_F90_f90.html#robo_top_of_doc">H5_ff_F90.f90</a>,
+ which is just a place holder blank module, is compiled.
+</pre>
+<p class="item_name">NOTES</p>
+<pre> *** IMPORTANT ***
+ If you add a new function you must add the function name to the
+ Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
+ This is needed for Windows based operating systems.
+</pre>
+
+<hr />
+<a name="H5LIB2fh5check5fversion5ff"></a>
+<a name="robo111"></a><h2>h5check_version_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5check_version_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Verifies that library versions are consistent.
+</pre>
+<p class="item_name">INPUTS</p>
+<pre> majnum - major version of the library
+ minum - minor version of the library
+ relnum - release version of the library
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> error - error code
+ Success: 0
+ Failure: application aborts
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> Elena Pourmal
+ September 24, 2002
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5check_version_f</strong><span class="sign">(</span>majnum<span class="sign">,</span> minnum<span class="sign">,</span> relnum<span class="sign">,</span> error<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> majnum<span class="sign">,</span> minnum<span class="sign">,</span> relnum
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error
+</pre>
+
+<hr />
+<a name="H5LIB2fh5close5ff"></a>
+<a name="robo112"></a><h2>h5close_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5close_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Closes the <a href="./HDF5_f90.html#robo76">HDF5</a> library and Fortran90 interface.
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> error - error code
+ Success: 0
+ Failure: -1
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> Elena Pourmal
+ August 12, 1999
+</pre>
+<p class="item_name">HISTORY</p>
+<pre> Explicit Fortran interfaces were added for
+ called C functions (it is needed for Windows
+ port). February 28, 2001
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5close_f</strong><span class="sign">(</span>error<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error
+</pre>
+
+<hr />
+<a name="H5LIB2fh5dont5fatexit5ff"></a>
+<a name="robo122"></a><h2>h5dont_atexit_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5dont_atexit_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Instructs library not to install atexit cleanup routine.
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> error - error code
+ Success: 0
+ Failure: -1
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> Elena Pourmal
+ September 24, 2002
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5dont_atexit_f</strong><span class="sign">(</span>error<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error
+</pre>
+
+<hr />
+<a name="H5LIB2fh5garbage5fcollect5ff"></a>
+<a name="robo150"></a><h2>h5garbage_collect_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5garbage_collect_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Garbage collects on all free-lists of all types.
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> error - error code
+ Success: 0
+ Failure: -1
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> Elena Pourmal
+ September 24, 2002
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5garbage_collect_f</strong><span class="sign">(</span>error<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error
+</pre>
+
+<hr />
+<a name="H5LIB2fh5get5flibversion5ff"></a>
+<a name="robo154"></a><h2>h5get_libversion_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5get_libversion_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Returns the <a href="./HDF5_f90.html#robo76">HDF5</a> LIbrary release number
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> majnum - major version of the library
+ minum - minor version of the library
+ relnum - release version of the library
+ error - error code
+ Success: 0
+ Failure: -1
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> Elena Pourmal
+ September 24, 2002
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5get_libversion_f</strong><span class="sign">(</span>majnum<span class="sign">,</span> minnum<span class="sign">,</span> relnum<span class="sign">,</span> error<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> majnum<span class="sign">,</span> minnum<span class="sign">,</span> relnum<span class="sign">,</span> error
+</pre>
+
+<hr />
+<a name="H5LIB2fh5kind5fto5ftype"></a>
+<a name="robo177"></a><h2>h5kind_to_type</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5kind_to_type</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Converts the KIND to the correct HDF type
+</pre>
+<p class="item_name">INPUTS</p>
+<pre> kind - Fortran KIND parameter
+ flag - whether KIND is of type INTEGER or REAL:
+ H5_INTEGER_KIND - integer
+ H5_REAL_KIND - real
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> h5_type - returns the type
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> M. Scot Breitenfeld
+ Augest 25, 2008
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span> FUNCTION <strong>h5kind_to_type</strong><span class="sign">(</span>kind<span class="sign">,</span> flag<span class="sign">)</span> RESULT<span class="sign">(</span>h5_type<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> kind
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> flag
+</pre>
+
+<hr />
+<a name="H5LIB2fh5open5ff"></a>
+<a name="robo198"></a><h2>h5open_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo53">H5LIB</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5open_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Initializes the <a href="./HDF5_f90.html#robo76">HDF5</a> library and Fortran90 interface.
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> error - error code
+ Success: 0
+ Failure: -1
+</pre>
+<p class="item_name">AUTHOR</p>
+<pre> Elena Pourmal
+ August 12, 1999
+</pre>
+<p class="item_name">HISTORY</p>
+<pre> Explicit Fortran interfaces were added for
+ called C functions (it is needed for Windows
+ port). February 28, 2001
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5open_f</strong><span class="sign">(</span>error<span class="sign">)</span>
+ USE <a href="./H5f90global_f90.html#robo46">H5GLOBAL</a>
+ IMPLICIT NONE
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error
+</pre>
+
+</div> <!-- content -->
+<div id="footer">
+<p>Generated from ./src/H5_ff.f90 on Sun Aug 14 2011 22:49:38
+</p>
+</div> <!-- footer -->
+</body>
+</html>
generated by cgit v0.12 at 2024-07-19 09:53:51 (GMT)