From 863760f6a42453c200db38f4e6d3ae74b49115ad Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 23 Oct 2003 16:58:37 -0500 Subject: [svn-r7719] Purpose: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Touch up function index Minor format fixes and copy edits Platforms tested: Safari --- doc/html/RM_H5T.html | 1286 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 1009 insertions(+), 277 deletions(-) diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 4031bc3..05c361e 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -61,7 +61,8 @@ And in this document, the -
+
+

H5T: Datatype Interface

@@ -165,9 +166,9 @@ of a dataset.
Alphabetical Listing - +
- - + - - +
+
  • H5Tarray_create
  • H5Tclose
  • H5Tcommit @@ -191,9 +192,9 @@ of a dataset.
  • H5Tget_inpad
    		•              +
  • H5Tget_member_class
  • H5Tget_member_index
  • H5Tget_member_name @@ -217,7 +218,7 @@ of a dataset.
  • H5Tis_variable_str
    		•             
  • H5Tlock @@ -247,17 +248,9 @@ of a dataset.
    The FORTRAN90 Interfaces:
    - - -In general, each FORTRAN90 subroutine performs exactly the same task -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. -
    +In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. +
    @@ -433,10 +426,23 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -464,10 +470,20 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -503,10 +519,22 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -539,10 +567,19 @@ in the HDF5 User's Guide for further information, including a compl if the datatype has been committed, or 0 (zero), for FALSE, if the datatype has not been committed. Otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -600,11 +637,17 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + @@ -696,10 +739,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a datatype identifier if successful; otherwise returns a negative value -
    Non-C API(s): -
    - @@ -741,10 +795,24 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns datatype identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -783,10 +851,18 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns TRUE or FALSE if successful; otherwise returns a negative value. - + + @@ -814,10 +890,22 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns the datatype identifier for the new enumeration datatype if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -860,10 +948,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -910,10 +1009,22 @@ in the HDF5 User's Guide for further information, including a compl and, if size allows it, the first character of name is set to NULL. -
    Non-C API(s): -
    - @@ -951,10 +1062,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -986,10 +1108,22 @@ in the HDF5 User's Guide for further information, including a compl if the datatype identifiers refer to the same datatype, or 0 (zero), for FALSE. Otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1027,11 +1161,17 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL. +
    Fortran90 Interface: +
    None. + + @@ -1069,10 +1209,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1100,10 +1251,20 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns the rank of the array if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1143,10 +1304,31 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns datatype class identifier if successful; otherwise H5T_NO_CLASS (-1). -
    Non-C API(s): -
    - @@ -1177,10 +1359,23 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a valid character set type if successful; otherwise H5T_CSET_ERROR (-1). -
    Non-C API(s): -
    - @@ -1206,10 +1401,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns the bias if successful; otherwise 0. -
    Non-C API(s): -
    - @@ -1254,10 +1460,23 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1293,10 +1512,25 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a valid padding type if successful; otherwise H5T_PAD_ERROR (-1). -
    Non-C API(s): -
    - @@ -1328,12 +1562,16 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. - + @@ -1370,12 +1608,17 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a valid field or member index if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. - @@ -1418,10 +1661,24 @@ in the HDF5 User's Guide for further information, including a compl
    Returns a valid pointer to a string allocated with malloc() if successful; otherwise returns NULL. -
    Non-C API(s): -
    - @@ -1456,10 +1713,23 @@ in the HDF5 User's Guide for further information, including a compl Note that zero is a valid offset and that this function will fail only if a call to H5Tget_member_class() fails with the same arguments. -
    Non-C API(s): -
    - @@ -1490,10 +1760,23 @@ in the HDF5 User's Guide for further information, including a compl
    Returns the identifier of a copy of the datatype of the field if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1530,10 +1813,22 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1618,11 +1913,17 @@ in the HDF5 User's Guide for further information, including a compl
    Returns the native datatype identifier for the specified dataset datatype if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + @@ -1650,10 +1951,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns the number of elements if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1688,10 +2000,30 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a valid normalization type if successful; otherwise H5T_NORM_ERROR (-1). -
    Non-C API(s): -
    - @@ -1763,10 +2095,21 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns an offset value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1803,10 +2146,25 @@ in the HDF5 User's Guide for further information, including a compl
    Returns:
    Returns a byte order constant if successful; otherwise H5T_ORDER_ERROR (-1). -
    Non-C API(s): -
    - @@ -1837,11 +2195,17 @@ H5Tget_overflow ()
    Returns a pointer to an application-defined function if successful. Otherwise returns NULL; this can happen if no overflow handling function is registered. +
    Fortran90 Interface: +
    None. + + @@ -1884,10 +2248,30 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -1915,10 +2299,20 @@ H5Tget_overflow ()
    Returns:
    Returns the number of significant bits if successful; otherwise 0. -
    Non-C API(s): -
    - @@ -1951,10 +2345,28 @@ H5Tget_overflow ()
    Returns:
    Returns a valid sign type if successful; otherwise H5T_SGN_ERROR (-1). -
    Non-C API(s): -
    - @@ -1980,10 +2392,21 @@ H5Tget_overflow ()
    Returns:
    Returns the size of the datatype in bytes if successful; otherwise 0. -
    Non-C API(s): -
    - @@ -2011,10 +2434,26 @@ H5Tget_overflow ()
    Returns:
    Returns a valid string storage mechanism if successful; otherwise H5T_STR_ERROR (-1). -
    Non-C API(s): -
    - @@ -2043,10 +2482,20 @@ H5Tget_overflow ()
    Returns:
    Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2076,10 +2525,22 @@ H5Tget_overflow ()
    Returns:
    Returns a pointer to an allocated string if successful; otherwise returns NULL. -
    Non-C API(s): -
    - @@ -2122,10 +2583,24 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2155,10 +2630,23 @@ H5Tget_overflow ()
    Returns:
    Returns TRUE or FALSE if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2189,11 +2677,17 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + @@ -2226,10 +2720,23 @@ H5Tget_overflow ()
    Returns:
    Returns a named datatype identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2256,10 +2763,19 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2353,11 +2869,17 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + @@ -2394,10 +2916,23 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2426,10 +2961,22 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2477,10 +3024,23 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2521,10 +3081,26 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2562,10 +3138,30 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2647,10 +3243,21 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2688,10 +3295,25 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2729,11 +3351,17 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + @@ -2773,10 +3401,30 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2815,10 +3463,20 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2837,15 +3495,15 @@ zero.
    Sets the sign property for an integer type.
    Description:
    H5Tset_sign sets the sign property for an integer type. -
      -
      H5T_SGN_NONE (0) -
      Unsigned integer type. -
      H5T_SGN_2 (1) -
      Two's complement signed integer type. -
    +
    +
    H5T_SGN_NONE (0) +
    Unsigned integer type. +
    H5T_SGN_2 (1) +
    Two's complement signed integer type. +
    Parameters: -
    -
    hid_t type_id +
    +
    hid_t type_id
    Identifier of datatype to set.
    H5T_sign_t sign
    Sign type. @@ -2853,10 +3511,28 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2896,10 +3572,21 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2957,10 +3644,26 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -2991,10 +3694,21 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -3023,11 +3737,17 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. +
    Fortran90 Interface: +
    None. + + @@ -3067,10 +3787,21 @@ zero.
    Returns:
    Returns datatype identifier if successful; otherwise returns a negative value. -
    Non-C API(s): -
    - @@ -3109,13 +3840,14 @@ And in this document, the
    -
    +
    +
    HDF Help Desk
    -Describes HDF5 Release 1.6.0, July 2003 +Describes HDF5 Release 1.6.1, October 2003
    -- cgit v0.12