summaryrefslogtreecommitdiffstats
path: root/doc/html
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2003-06-18 20:52:54 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2003-06-18 20:52:54 (GMT)
commit1aeaa7fbb1072d18a533b7bbf8f996f6b194de73 (patch)
tree989cbf236bb9ed1bde75baa631a803eb75f7ee4e /doc/html
parentb6fca58d925dd2e8287b746b3deb81f71fc6e75f (diff)
downloadhdf5-1aeaa7fbb1072d18a533b7bbf8f996f6b194de73.zip
hdf5-1aeaa7fbb1072d18a533b7bbf8f996f6b194de73.tar.gz
hdf5-1aeaa7fbb1072d18a533b7bbf8f996f6b194de73.tar.bz2
[svn-r7059] Purpose:
Refactoring Description: Track changes to H5Fget_obj_<foo> API functions. Platforms tested: FreeBSD 4.8 (sleipnir) h5committest
Diffstat (limited to 'doc/html')
-rwxr-xr-xdoc/html/ADGuide/Changes.html5
-rw-r--r--doc/html/RM_H5F.html26
-rw-r--r--doc/html/fortran/h5f_FORTRAN.html3
3 files changed, 22 insertions, 12 deletions
diff --git a/doc/html/ADGuide/Changes.html b/doc/html/ADGuide/Changes.html
index ead527b..c506e37 100755
--- a/doc/html/ADGuide/Changes.html
+++ b/doc/html/ADGuide/Changes.html
@@ -70,8 +70,9 @@ Release 1.4.x versions of this document; they are not reported here.
<tr>
<td align="left" valign="top"><code>H5Fget_obj_ids</code></td>
<td align="left" valign="top">
- <em>herr_t </em><code>H5Fget_obj_ids</code> (<em>hid_t</em> <code>file_id</code>,
- <em>unsigned int</em> <code>types</code>, <em>hid_t *</em><code>obj_id_list</code>)
+ <em>int </em><code>H5Fget_obj_ids</code> (<em>hid_t</em> <code>file_id</code>,
+ <em>unsigned int</em> <code>types</code>,
+ <em>int</em> <code>max_objs</code>, <em>hid_t *</em><code>obj_id_list</code>)
</td>
</tr>
<tr>
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html
index 3408bb8..68626ce 100644
--- a/doc/html/RM_H5F.html
+++ b/doc/html/RM_H5F.html
@@ -529,9 +529,8 @@ facilitate moving easily between them.</i>
<dl>
<dt><strong>Name:</strong> <a name="File-GetObjCount">H5Fget_obj_count</a>
<dt><strong>Signature:</strong>
- <dd><em>herr_t </em><code>H5Fget_obj_count</code>(<em>hid_t</em> <code>file_id</code>,
- <em>unsigned int</em> <code>types</code>,
- <em>unsigned int *</em><code>obj_id_count</code>
+ <dd><em>int </em><code>H5Fget_obj_count</code>(<em>hid_t</em> <code>file_id</code>,
+ <em>unsigned int</em> <code>types</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the number of open object identifiers for an open file.
@@ -566,12 +565,17 @@ facilitate moving easily between them.</i>
</td><td valign=top>
Named datatypes only
</td></tr><tr><td valign=top>
+ <code>H5F_OBJ_ATTR&nbsp;&nbsp;</code>
+ </td><td valign=top>
+ Attributes only
+ </td></tr><tr><td valign=top>
<code>H5F_OBJ_ALL</code>
</td><td valign=top>
All of the above
<br>
(I.e., <code>H5F_OBJ_FILE</code> | <code>H5F_OBJ_DATASET</code> |
- <code>H5F_OBJ_GROUP</code> | <code>H5F_OBJ_DATATYPE</code> )
+ <code>H5F_OBJ_GROUP</code> | <code>H5F_OBJ_DATATYPE</code>
+ | <code>H5F_OBJ_ATTR</code> )
</td></tr>
</table>
</center>
@@ -586,11 +590,9 @@ facilitate moving easily between them.</i>
<code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.
<dt><em>unsigned int</em> <code>types</code>
<dd>IN: Type of object for which identifiers are to be returned.
- <dt><em>unsigned int *</em><code>obj_id_count</code>
- <dd>OUT: Pointer to the returned list of open object identifiers.
</dl>
<dt><strong>Returns:</strong>
- <dd>Returns a file access property list identifier if successful;
+ <dd>Returns a the number of open objects if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5f_FORTRAN.html#h5fget_obj_count_f"
@@ -606,8 +608,9 @@ facilitate moving easily between them.</i>
<dl>
<dt><strong>Name:</strong> <a name="File-GetObjIDs">H5Fget_obj_ids</a>
<dt><strong>Signature:</strong>
- <dd><em>herr_t </em><code>H5Fget_obj_ids</code>(<em>hid_t</em> <code>file_id</code>,
+ <dd><em>int </em><code>H5Fget_obj_ids</code>(<em>hid_t</em> <code>file_id</code>,
<em>unsigned int</em> <code>types</code>,
+ <em>int</em> <code>max_objs</code>,
<em>hid_t *</em><code>obj_id_list</code>
)
<dt><strong>Purpose:</strong>
@@ -625,6 +628,9 @@ facilitate moving easily between them.</i>
The types of object identifiers to be retrieved are specified
in <code>types</code> using the codes listed for the same
parameter in <a href="#File-GetObjCount"><code>H5Fget_obj_count</code></a>
+ <p>
+ To retrieve identifiers for all open objects, pass a negative value
+ for the <code>max_objs</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>file_id</code>
@@ -632,11 +638,13 @@ facilitate moving easily between them.</i>
<code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.
<dt><em>unsigned int</em> <code>types</code>
<dd>IN: Type of object for which identifiers are to be returned.
+ <dt><em>int</em> <code>max_objs</code>
+ <dd>IN: Maximum number of object identifiers to place into <code>obj_id_list</code>.
<dt><em>hid_t *</em><code>obj_id_list</code>
<dd>OUT: Pointer to the returned list of open object identifiers.
</dl>
<dt><strong>Returns:</strong>
- <dd>Returns a non-negative value if successful;
+ <dd>Returns number of objects placed into <code>obj_id_list</code> if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5f_FORTRAN.html#h5fget_obj_ids_f"
diff --git a/doc/html/fortran/h5f_FORTRAN.html b/doc/html/fortran/h5f_FORTRAN.html
index 6b6b999..cd8933b 100644
--- a/doc/html/fortran/h5f_FORTRAN.html
+++ b/doc/html/fortran/h5f_FORTRAN.html
@@ -300,7 +300,7 @@ FORTRAN File API -- h5f
<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5fget_obj_ids_f</strong>
<pre>
- SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, obj_ids, hdferr)
+ SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, max_objs, obj_ids, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
@@ -310,6 +310,7 @@ FORTRAN File API -- h5f
! H5F_OBJ_DATASET_F
! H5F_OBJ_DATATYPE_F
! H5F_OBJ_ALL_F
+ INTEGER, INTENT(IN) :: max_objs ! Maximum # of object IDs to retrieve
INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: obj_ids
! array of requested object identifiers
INTEGER, INTENT(OUT) :: hdferr ! Error code