summaryrefslogtreecommitdiffstats
path: root/fortran/doc/DevelGuide/src/H5Eff_f90.html
diff options
context:
space:
mode:
Diffstat (limited to 'fortran/doc/DevelGuide/src/H5Eff_f90.html')
-rw-r--r--fortran/doc/DevelGuide/src/H5Eff_f90.html197
1 files changed, 197 insertions, 0 deletions
diff --git a/fortran/doc/DevelGuide/src/H5Eff_f90.html b/fortran/doc/DevelGuide/src/H5Eff_f90.html
new file mode 100644
index 0000000..7eb95e6
--- /dev/null
+++ b/fortran/doc/DevelGuide/src/H5Eff_f90.html
@@ -0,0 +1,197 @@
+<?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/H5Eff.f90</title>
+<!-- Source: ./src/H5Eff.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="ROBODoc2fH5E"></a>
+<a name="robo35"></a><h2>H5E</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>H5E</strong>
+</pre>
+<p class="item_name">FILE</p>
+<pre> fortran/src/<a href="#robo_top_of_doc">H5Eff.f90</a>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> This Module contains Fortran interfaces for <strong>H5E</strong> functions.
+</pre>
+<p class="item_name">NOTES</p>
+<pre> *** IMPORTANT ***
+ If you add a new <strong>H5E</strong> function to the module 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="H5E2fh5eclear5ff"></a>
+<a name="robo128"></a><h2>h5eclear_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo35">H5E</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5eclear_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Clears the error stack for the current thread.
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> hdferr - Returns 0 if successful and -1 if fails
+</pre>
+<p class="item_name">OPTIONAL PARAMETERS</p>
+<pre> estack_id - Error Stack id
+</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). April 6, 2001
+
+ Added optional error stack identifier in order to bring
+ the function in line with the h5eclear2 routine.
+ MSB, July 9, 2009
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5eclear_f</strong><span class="sign">(</span>hdferr<span class="sign">,</span> estack_id<span class="sign">)</span>
+ 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> hdferr <span class="sign">!</span> Error code
+ INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> OPTIONAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> estack_id
+</pre>
+
+<hr />
+<a name="H5E2fh5eget5fmajor5ff"></a>
+<a name="robo130"></a><h2>h5eget_major_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo35">H5E</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5eget_major_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Returns a character string describing an error specified
+ by a major error number.
+</pre>
+<p class="item_name">INPUTS</p>
+<pre> error_no - major error number
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> name - character string describing the error
+ namelen - number of characters in the name buffer
+ hdferr - Returns 0 if successful and -1 if fails
+</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). April 6, 2001
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5eget_major_f</strong><span class="sign">(</span>error_no<span class="sign">,</span> name<span class="sign">,</span> namelen<span class="sign">,</span> hdferr<span class="sign">)</span>
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error_no <span class="sign">!</span> Major error number
+ CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Character string describing
+ <span class="sign">!</span> the error<span class="sign">.</span>
+ INTEGER<span class="sign">(</span>SIZE_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> namelen <span class="sign">!</span> Anticipated number of characters
+ <span class="sign">!</span> in name<span class="sign">.</span>
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
+</pre>
+
+<hr />
+<a name="H5E2fh5eget5fminor5ff"></a>
+<a name="robo131"></a><h2>h5eget_minor_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo35">H5E</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5eget_minor_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Returns a character string describing an error specified
+ by a minor error number.
+</pre>
+<p class="item_name">INPUTS</p>
+<pre> error_no - minor error number
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> name - character string describing the error
+ hdferr - Returns 0 if successful and -1 if fails
+</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). April 6, 2001
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5eget_minor_f</strong><span class="sign">(</span>error_no<span class="sign">,</span> name<span class="sign">,</span> hdferr<span class="sign">)</span>
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> error_no <span class="sign">!</span> Major error number
+ CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> Character string describing
+ <span class="sign">!</span> the error
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
+</pre>
+
+<hr />
+<a name="H5E2fh5eprint5ff"></a>
+<a name="robo132"></a><h2>h5eprint_f</h2>
+
+<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo35">H5E</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
+<p class="item_name">NAME</p>
+<pre> <strong>h5eprint_f</strong>
+</pre>
+<p class="item_name">PURPOSE</p>
+<pre> Prints the error stack in a default manner.
+</pre>
+<p class="item_name">OUTPUTS</p>
+<pre> hdferr - Returns 0 if successful and -1 if fails
+</pre>
+<p class="item_name">OPTIONAL PARAMETERS</p>
+<pre> name - name of the file that contains print output
+</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). April 6, 2001
+</pre>
+<p class="item_name">SOURCE</p>
+<pre class="source"> SUBROUTINE <strong>h5eprint_f</strong><span class="sign">(</span>hdferr<span class="sign">,</span> name<span class="sign">)</span>
+ CHARACTER<span class="sign">(</span>LEN<span class="sign">=</span><span class="sign">*</span><span class="sign">)</span><span class="sign">,</span> OPTIONAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> name <span class="sign">!</span> File name
+ INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
+</pre>
+
+</div> <!-- content -->
+<div id="footer">
+<p>Generated from ./src/H5Eff.f90 on Sun Aug 14 2011 22:49:38
+</p>
+</div> <!-- footer -->
+</body>
+</html>
generated by cgit v0.12 at 2024-11-08 19:02:42 (GMT)