diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2002-05-01 22:30:57 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2002-05-01 22:30:57 (GMT) |
commit | 6f3370b7b59ee3b6f8aa4ebb4be7f803bc64644f (patch) | |
tree | adbf008ac26d509148fad3d3e36f4a9219d63615 | |
parent | ce18afe66349e62d58fbcf1df187b52a1293d1f4 (diff) | |
download | hdf5-6f3370b7b59ee3b6f8aa4ebb4be7f803bc64644f.zip hdf5-6f3370b7b59ee3b6f8aa4ebb4be7f803bc64644f.tar.gz hdf5-6f3370b7b59ee3b6f8aa4ebb4be7f803bc64644f.tar.bz2 |
[svn-r5315]
Purpose:
Bugfix -- fixes #751
Description:
Elaborated on 'ref' parameter type.
Platforms tested:
IE 5
-rw-r--r-- | doc/html/RM_H5R.html | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index 92ed7c1..e6be079 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -125,11 +125,29 @@ facilitate moving easily between them.</i> of the type specified in <code>ref_type</code>, pointing to the object <code>name</code> located at <code>loc_id</code>. <p> + The HDF5 library maps the <em>void</em> type specified above + for <code>ref</code> to the type specified in <code>ref_type</code>, + which will be one of those appearing in the first column of + the following table. + The second column of the table lists the HDF5 constant associated + with each reference type. + <dir> + <table border=0> + <tr><td><em>hdset_reg_ref_t</em> </td> + <td><code>H5R_DATASET_REGION</code> </td> + <td>Dataset region reference</td></tr> + <tr><td><em>hobj_ref_t</em></td> + <td><code>H5R_OBJECT</code></td> + <td>Object reference</td></tr> + </table> + </dir> + <p> The parameters <code>loc_id</code> and <code>name</code> are used to locate the object. <p> The parameter <code>space_id</code> identifies the region - to be pointed to (for dataset region references). + 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> @@ -320,7 +338,7 @@ H5R <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 13 July 2000 +Last modified: 30 April 2002 <br> Describes HDF5 Release 1.5, Unreleased Development Branch |