diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2004-02-24 22:10:12 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2004-02-24 22:10:12 (GMT) |
commit | 9fb77d56b800f04e7818190f50193028a134603f (patch) | |
tree | e6d5c34ec5d291a8a4f43a97c6ba48f520153bf8 /doc/html/RM_H5R.html | |
parent | f29e2a01e35e466fdcc292a0c443265efdf4b025 (diff) | |
download | hdf5-9fb77d56b800f04e7818190f50193028a134603f.zip hdf5-9fb77d56b800f04e7818190f50193028a134603f.tar.gz hdf5-9fb77d56b800f04e7818190f50193028a134603f.tar.bz2 |
[svn-r8221]
Purpose:
Clean up RM formatting.
Modify RM HTML code to facilitate automated generation of PDF version.
Minor edits.
Description:
Reworked format of "Parameters" sections.
Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to
generate PDF files.
Fixed the "Copyright" link on RM_H5Front.html.
Other minor copy edits.
Platforms tested:
IE 5
Diffstat (limited to 'doc/html/RM_H5R.html')
-rw-r--r-- | doc/html/RM_H5R.html | 109 |
1 files changed, 61 insertions, 48 deletions
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index 1443e11..5c93eb9 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5R: Reference Interface</h1> </center> @@ -195,27 +194,32 @@ as the corresponding C function. to be pointed to for a dataset region reference. This parameter is unused with object references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>void *</em><code>ref</code> - <dd>OUT: Reference created by the function call. - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Location identifier used to locate the object being - pointed to. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of object at location <code>loc_id</code>. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: Type of reference. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier with selection. - Used for dataset region references. - </dl> + <ul><table> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">OUT: Reference created by the function call.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Location identifier used to locate the object being + pointed to.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Name of object at location <code>loc_id</code>.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: Type of reference.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier with selection. + Used for dataset region references.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5rcreate_f - <p><strong>To create an object reference</strong> - <dd> + <dd><p><strong>To create an object reference</strong> + <pre> SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr) IMPLICIT NONE @@ -227,9 +231,10 @@ SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr) END SUBROUTINE h5rcreate_f </pre></dt> + +<!-- NEW PAGE --> +<dt><dd><strong>To create a region reference</strong> -<dt><strong>To create a region reference</strong> - <dd> <pre> SUBROUTINE h5rcreate_f(loc_id, name, space_id, ref, hdferr) IMPLICIT NONE @@ -275,14 +280,17 @@ END SUBROUTINE h5rcreate_f <li><code>H5R_DATASET_REGION</code> (<code>1</code>) </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset</code> - <dd>IN: Dataset containing reference object. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: The reference type of <code>ref</code>. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset</code></td> + <td valign="top">IN: Dataset containing reference object.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: The reference type of <code>ref</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns valid identifier if successful; otherwise returns a negative value. @@ -374,16 +382,19 @@ END SUBROUTINE h5rdereference_f </td></tr> </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>id</code>, - <dd>IN: The dataset containing the reference object or + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>id</code>,</td> + <td valign="top">IN: The dataset containing the reference object or the location identifier of the object that the - dataset is located within. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: Type of reference to query. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to query. - </dl> + dataset is located within.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: Type of reference to query.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns an object type as defined in <code>H5Gpublic.h</code> if successful; otherwise returns <code>H5G_UNKNOWN</code>. @@ -439,14 +450,17 @@ END SUBROUTINE h5rget_object_type_f <li><code>H5R_DATASET_REGION</code> (<code>1</code>) </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset</code>, - <dd>IN: Dataset containing reference object. - <dt><em>H5R_type_t</em> <code>ref_type</code>, - <dd>IN: The reference type of <code>ref</code>. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset</code></td> + <td valign="top">IN: Dataset containing reference object.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: The reference type of <code>ref</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid identifier if successful; otherwise returns a negative value. @@ -504,14 +518,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 21 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> |