diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1999-12-13 20:39:48 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1999-12-13 20:39:48 (GMT) |
commit | 658fdbfb981b60eb42a6be70b5e2baf9f01989cd (patch) | |
tree | 5da339df5c8e5186fb760c16fcee5bbc0fbbffe3 /doc/html/RM_H5A.html | |
parent | ca73fde3ba444896894a56dda3dc9f79d06a7bcd (diff) | |
download | hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.zip hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.tar.gz hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.tar.bz2 |
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.
(except Datatypes.html, H5.format.html, ddl.html)
This version of HDF5 Ref Manual includes FORTRAN API references.
Diffstat (limited to 'doc/html/RM_H5A.html')
-rw-r--r-- | doc/html/RM_H5A.html | 135 |
1 files changed, 132 insertions, 3 deletions
diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index 0417752..e452644 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -51,6 +51,9 @@ H5A These functions create and manipulate attributes and information about attributes. +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> <ul> @@ -77,6 +80,47 @@ and information about attributes. </table> <p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Annot-Create">h5acreate_f</a> + <li><a href="#Annot-Write">h5awrite_f</a> + <li><a href="#Annot-Read">h5aread_f</a> + <li><a href="#Annot-Close">h5aclose_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Annot-GetName">h5aget_name_f</a> + <li><a href="#Annot-OpenName">h5aopen_name_f</a> + <li><a href="#Annot-OpenIdx">h5aopen_idx_f</a> + <li><a href="#Annot-GetSpace">h5aget_space_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Annot-GetType">h5aget_type_f</a> + <li><a href="#Annot-NumAttrs">h5aget_num_attrs_f</a> + <!--<li><a href="#Annot-Iterate">h5aiterate_f</a>--> + <li><a href="#Annot-Delete">h5adelete_f</a> +</ul> +</td></tr> +</table> + + +<p> The Attribute interface, H5A, is primarily designed to easily allow small datasets to be attached to primary datasets as metadata information. Additional goals for the H5A interface include keeping storage requirement @@ -140,6 +184,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns an attribute identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5acreate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -172,6 +223,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns attribute identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aopen_name_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -205,6 +263,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns attribute identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aopen_idx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -243,6 +308,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5awrite_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -276,11 +348,18 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><em>hid_t</em> <code>mem_type_id</code> <dd>IN: Identifier of the attribute datatype (in memory). <dt><em>void *</em><code>buf</code> - <dd>IN: Buffer for data to be read. + <dd>OUT: Buffer for data to be read. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aread_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -304,6 +383,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns attribute dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_space_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -333,6 +419,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_type_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -340,7 +433,7 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dl> <dt><strong>Name:</strong> <a name="Annot-GetName">H5Aget_name</a> <dt><strong>Signature:</strong> - <dd><em>hssize_t</em> <code>H5Aget_name</code>(<em>hid_t</em> <code>attr_id</code>, + <dd><em>ssize_t</em> <code>H5Aget_name</code>(<em>hid_t</em> <code>attr_id</code>, <em>size_t</em> <code>buf_size</code>, <em>char *</em><code>buf</code> ) @@ -367,6 +460,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dd>Returns the length of the attribute's name, which may be longer than <code>buf_size</code>, if successful. Otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_name_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -390,6 +490,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns the number of attributes if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_num_attrs_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -454,6 +561,14 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dd>If successful, returns the return value of the last operator if it was non-zero, or zero if all attributes were processed. Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aiterate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -484,6 +599,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5adelete_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -507,6 +629,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -550,7 +679,7 @@ H5A <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> |