diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1999-04-23 20:43:12 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1999-04-23 20:43:12 (GMT) |
commit | a1e8b8b62e8d4fdcf5b618a9e0bf4bdf45ffc3ec (patch) | |
tree | 62bd6f431fc3723e1bbfaaa72c0c4f0b753739e5 /doc/html/RM_H5R.html | |
parent | f03f167b5aa9efca4302db817f2d9f1a8b5b93fb (diff) | |
download | hdf5-a1e8b8b62e8d4fdcf5b618a9e0bf4bdf45ffc3ec.zip hdf5-a1e8b8b62e8d4fdcf5b618a9e0bf4bdf45ffc3ec.tar.gz hdf5-a1e8b8b62e8d4fdcf5b618a9e0bf4bdf45ffc3ec.tar.bz2 |
[svn-r1206] RM_H5R.html
Corrected parameter and return types in function prototypes
and parameter descriptions
Deleted comments regarding unimplemented functionality in R1.0
which has since been implemented
Cleaned up formatting of commands TOC at top of page
References.html
Corrected parameter and return types in function prototypes
and in example code
Deleted comments regarding unimplemented functionality in R1.0
which has since been implemented
Diffstat (limited to 'doc/html/RM_H5R.html')
-rw-r--r-- | doc/html/RM_H5R.html | 32 |
1 files changed, 12 insertions, 20 deletions
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index b558e81..d138670 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -52,35 +52,30 @@ The Reference interface allows the user to create references to specific objects and data regions in an HDF5 file. <p> -<table border=0> -<tr><td valign=top> + +<table border=0 width=98%> +<tr><td valign=top width=33%> <ul> <li><a href="#Reference-Create">H5Rcreate</a> </ul> -</td><td> </td><td valign=top> +</td><td valign=top width=33%> <ul> <li><a href="#Reference-Dereference">H5Rdereference</a> </ul> -</td><td> </td><td valign=top> +</td><td valign=top width=34%> <ul> - <li><a href="#Reference-GetRegion">H5Rget_region</a> (NYI) + <li><a href="#Reference-GetRegion">H5Rget_region</a> </ul> </td></tr> -<tr><td colspan=5 align=right><font size=-1> -NYI = Not yet implemented.</font> -</td></tr> </table> <p> -<i>Note: The only type of reference implemented in this release -is an object reference pointing to a dataset.</i> -<p> <hr> <dl> <dt><strong>Name:</strong> <a name="Reference-Create">H5Rcreate</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Rcreate</code>(<em>href_t *</em><code>ref</code>, + <dd><em>herr_t</em> <code>H5Rcreate</code>(<em>void *</em><code>ref</code>, <em>hid_t</em> <code>loc_id</code>, <em>const char *</em><code>name</code>, <em>H5R_type_t</em> <code>ref_type</code>, @@ -98,12 +93,9 @@ is an object reference pointing to a dataset.</i> <p> The parameter <code>space_id</code> identifies the region to be pointed to (for dataset region references). - <p> - <i>Note: Only object references of type <code>H5T_STD_REF_OBJ</code> - pointing to entire datasets are implemented at this time.</i> <dt><strong>Parameters:</strong> <dl> - <dt><em>href_t *</em><code>ref</code> + <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 @@ -128,7 +120,7 @@ is an object reference pointing to a dataset.</i> <dt><strong>Signature:</strong> <dd><em>hid_t</em> <code>H5Rdereference</code>(<em>hid_t</em> <code>dataset</code>, <em>H5R_type_t</em> <code>ref_type</code>, - <em>href_t *</em><code>ref</code> + <em>void *</em><code>ref</code> ) <dt><strong>Purpose:</strong> <dd>Opens the HDF5 object referenced. @@ -161,9 +153,9 @@ is an object reference pointing to a dataset.</i> <dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a> <i>(Not yet implemented.)</i> <dt><strong>Signature:</strong> - <dd><em>hid_t</em> <code>H5Rget_region</code>(<em>hid_t</em> <code>dataset</code>, + <dd><em>H5S_t</em> <code>H5Rget_region</code>(<em>H5D_t</em> <code>dataset</code>, <em>H5R_type_t</em> <code>ref_type</code>, - <em>href_t *</em><code>ref</code> + <em>void *</em><code>ref</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves a dataspace with the specified region selected. @@ -184,7 +176,7 @@ is an object reference pointing to a dataset.</i> <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>href_t *</em><code>ref</code> + <dt><em>void *</em><code>ref</code> <dd>IN: Reference to open. </dl> <dt><strong>Returns:</strong> |