From 03dd1f7e2fafcff208542cbaa56f9e6bc16056d7 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 7 Oct 2003 12:31:35 -0500 Subject: [PATCH] [svn-r7564] Purpose: Aphabetic sort of RM function entries Platforms tested: IE 5, Safari --- doc/html/RM_H5I.html | 135 ++++++++++++++++++++++--------------------- 1 file changed, 69 insertions(+), 66 deletions(-) diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 0bcf1ec616..409de63724 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -25,6 +25,7 @@ HDF5/H5I API Specification +
@@ -60,8 +61,7 @@ And in this document, the -
-
+

H5I: Identifier Interface

@@ -91,20 +91,20 @@ object names. -

+
The FORTRAN90 Interface:
In general, each FORTRAN90 subroutine performs exactly the same task -as the corresponding C function. The links below go to the C function +as the corresponding C function. The links below (electronic versions only) go to the C function descriptions, which serve as general descriptions for both. A button, under Non-C API(s) 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. - +
@@ -122,62 +122,9 @@ facilitate moving easily between them.
- -

-
-
Name: H5Iget_type -
Signature: -
H5I_type_t H5Iget_type(hid_t obj_id) -
Purpose: -
Retrieves the type of an object. -
Description: -
H5Iget_type retrieves the type of the object - identified by obj_id. -

- Valid types returned by the function are - - - - - - - -
    H5I_FILE - File
    H5I_GROUP - Group
    H5I_DATATYPE - Datatype
    H5I_DATASPACE - Dataspace
    H5I_DATASET - Dataset
    H5I_ATTR - Attribute
- If no valid type can be determined or the identifier - submitted is invalid, the function returns - - -
    H5I_BADID - Invalid identifier
-

- This function is of particular value in determining the - type of object closing function (H5Dclose, - H5Gclose, etc.) to call after a call to - H5Rdereference. -

Parameters: -
-
hid_t obj_id -
IN: Object identifier whose type is to be determined. -
-
Returns: -
Returns the object type if successful; - otherwise H5I_BADID. -
Non-C API(s): -
- -
- - + + +
Name: H5Iget_name @@ -236,6 +183,61 @@ facilitate moving easily between them. -->
+ + +
+
+
Name: H5Iget_type +
Signature: +
H5I_type_t H5Iget_type(hid_t obj_id) +
Purpose: +
Retrieves the type of an object. +
Description: +
H5Iget_type retrieves the type of the object + identified by obj_id. +

+ Valid types returned by the function are + + + + + + + +
    H5I_FILE + File
    H5I_GROUP + Group
    H5I_DATATYPE + Datatype
    H5I_DATASPACE + Dataspace
    H5I_DATASET + Dataset
    H5I_ATTR + Attribute
+ If no valid type can be determined or the identifier + submitted is invalid, the function returns + + +
    H5I_BADID + Invalid identifier
+

+ This function is of particular value in determining the + type of object closing function (H5Dclose, + H5Gclose, etc.) to call after a call to + H5Rdereference. +

Parameters: +
+
hid_t obj_id +
IN: Object identifier whose type is to be determined. +
+
Returns: +
Returns the object type if successful; + otherwise H5I_BADID. +
Non-C API(s): +
+ +
@@ -270,14 +272,15 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.6.0, July 2003 -
- -Last modified: 10 June 2003 +