From 315e9c17f468831ce06e572bc3cbd8d0335973e4 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Mon, 17 Jul 2000 14:14:30 -0500 Subject: [svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections. --- doc/html/RM_H5E.html | 105 ++++++++++++++- doc/html/RM_H5Front.html | 13 +- doc/html/RM_H5I.html | 46 ++++++- doc/html/RM_H5P.html | 339 ++++++++++++++++++++++------------------------- doc/html/RM_H5R.html | 69 +++++++++- doc/html/RM_H5T.html | 312 +++++++++++++++++++------------------------ 6 files changed, 520 insertions(+), 364 deletions(-) diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index 7b632a7..17f517c 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -50,6 +50,9 @@ H5E   These functions provide error handling capabilities in the HDF5 environment. +

+The C Interfaces: +
    @@ -72,6 +75,42 @@ These functions provide error handling capabilities in the HDF5 environment.

+The FORTRAN90 Interfaces: + +
+ +In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below 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. + + + + +
+ +       + +       + +
+ +

The Error interface provides error handling in the form of a stack. The FUNC_ENTER() macro clears the error stack whenever an interface function is entered. @@ -131,6 +170,13 @@ errors within the H5E package.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Non-C API(s): +
+ @@ -160,6 +206,15 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. + + @@ -185,6 +240,13 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Non-C API(s): +
+ @@ -213,6 +275,13 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Non-C API(s): +
+ @@ -283,6 +352,15 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. + + @@ -331,6 +409,15 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. + + @@ -353,6 +440,13 @@ errors within the H5E package.
Returns:
Returns a character string describing the error if successful. Otherwise returns "Invalid major error number." +
Non-C API(s): +
+ @@ -375,6 +469,13 @@ errors within the H5E package.
Returns:
Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number." +
Non-C API(s): +
+ @@ -418,7 +519,9 @@ H5E   HDF Help Desk
-Last modified: 30 October 1998 +Last modified: 13 July 2000 +
+Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.) diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index a26b151..f891a4a 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -45,6 +45,13 @@ HDF5 Reference Manual  

HDF5: API Specification
Reference Manual

+ + +
The HDF5 library provides several interfaces, each of which provides the tools required to meet specific aspects of the HDF5 data-handling requirements. @@ -53,7 +60,7 @@ tools required to meet specific aspects of the HDF5 data-handling requirements. A note regarding the prototype FORTRAN90 APIs:
This version of the HDF5 Reference Manual includes a description of a partial FORTRAN90 prototype API to HDF5. -Prototype Fortran subroutines exist in the H5A, H5D, H5F, H5G, H5P, H5S, and H5T +Prototype Fortran subroutines exist in the H5A, H5D, H5E, H5F, H5G, H5I, H5P, H5R, H5S, and H5T interfaces and are described on those pages.

In general, each Fortran subroutine performs exactly the same task @@ -171,10 +178,12 @@ HDF5 Reference Manual   HDF Help Desk
-Last modified: 26 April 1999 +Last modified: 17 July 2000 Copyright   +
+Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.) diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 841c859..eb1c7d9 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -49,7 +49,10 @@ H5I  

Identifier API Functions

This function provides a tool for working with object identifiers. + +

+The C Interface:
@@ -68,6 +71,38 @@ This function provides a tool for working with object identifiers.
+

+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 +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. + + + + +
+ +       +
    +   +
+		       +
    +   +
+
+ +

Name: H5Iget_type @@ -113,6 +148,13 @@ This function provides a tool for working with object identifiers.
Returns:
Returns the object type if successful; otherwise H5I_BADID. +
Non-C API(s): +
+
@@ -156,7 +198,9 @@ H5I   HDF Help Desk
-Last modified: 30 October 1998 +Last modified: 14 July 2000 +
+Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index b732d01..29445cd 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -118,8 +118,7 @@ many different parameters to be easily manipulated.
 
 
-||  Available only in the -parallel HDF5 library. +||  Available only in the parallel HDF5 library.        @@ -196,18 +195,18 @@ facilitate moving easily between them.
  • h5pclose_f - - - - - - - - - - - - +

    File Creation Properties +

    @@ -217,38 +216,48 @@ facilitate moving easily between them.        - -       - - - - - - - - - - - - - + File Access Properties + + + +
      +
    +||  Available only in the parallel HDF5 library. +        Dataset Creation Properties - - +

    Dataset Memory and Transfer Properties +

    @@ -464,11 +473,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -499,11 +507,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -532,11 +539,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -573,11 +579,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -610,11 +615,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -659,11 +663,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -698,11 +701,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if the file access property list is set to the MPI. Otherwise returns a negative value. - @@ -744,11 +746,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -779,11 +780,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -830,11 +830,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -872,11 +871,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -914,11 +912,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -951,11 +948,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -999,11 +995,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1040,11 +1035,10 @@ facilitate moving easily between them.
    Returns the layout type of a a dataset creation property list if successful. Otherwise returns H5D_LAYOUT_ERROR (-1). - @@ -1175,11 +1169,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1214,11 +1207,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1267,11 +1259,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1297,11 +1288,10 @@ facilitate moving easily between them.
    Returns:
    Returns the number of external files if successful; otherwise returns a negative value. - @@ -1354,11 +1344,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1531,11 +1520,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1577,7 +1565,7 @@ facilitate moving easily between them. otherwise returns a negative value. @@ -1695,11 +1682,10 @@ facilitate moving easily between them.
    Returns:
    Returns a low-level driver identifier if successful. Otherwise returns H5F_LOW_ERROR (-1). - @@ -1726,11 +1712,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1759,11 +1744,10 @@ facilitate moving easily between them.
    Returns a non-negative value if the file access property list is set to the stdio driver. Otherwise returns a negative value. - @@ -1791,11 +1775,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1824,11 +1807,10 @@ facilitate moving easily between them.
    Returns a non-negative value if the file access property list is set to the sec2 driver. Otherwise returns a negative value. - @@ -1864,11 +1846,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1903,11 +1884,10 @@ facilitate moving easily between them.
    Returns a non-negative value if the file access property list is set to the core driver. Otherwise returns a negative value. - @@ -1956,11 +1936,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2024,11 +2003,10 @@ facilitate moving easily between them.
    Returns a non-negative value if the file access property list is set to the split driver. Otherwise returns a negative value. - @@ -2070,11 +2048,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2108,11 +2085,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2170,7 +2146,7 @@ facilitate moving easily between them.
    Returns a non-negative value if successful; otherwise returns a negative value.
    Non-C API(s): -
    @@ -2214,7 +2190,7 @@ facilitate moving easily between them. to the family driver. Otherwise returns a negative value.
    Non-C API(s): -
    @@ -2272,11 +2248,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2296,7 +2271,8 @@ facilitate moving easily between them.
    Purpose:
    Queries the meta data cache and raw data chunk cache parameters.
    Description: -
    Retrieves the maximum possible number of elements in the meta +
    H5Pget_cache retrieves the maximum possible + number of elements in the meta data cache and raw data chunk cache, the maximum possible number of bytes in the raw data chunk cache, and the preemption policy value.

    @@ -2318,11 +2294,10 @@ facilitate moving easily between them.

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2376,11 +2351,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2415,11 +2389,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2466,11 +2439,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2509,11 +2481,10 @@ facilitate moving easily between them.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2571,7 +2542,7 @@ facilitate moving easily between them. otherwise returns a negative value. @@ -149,6 +191,13 @@ to specific objects and data regions in an HDF5 file.
    Returns:
    Returns valid identifier if successful; otherwise returns a negative value. +
    Non-C API(s): +
    + @@ -186,6 +235,13 @@ to specific objects and data regions in an HDF5 file.
    Returns:
    Returns a valid identifier if successful; otherwise returns a negative value. +
    Non-C API(s): +
    + @@ -214,6 +270,13 @@ to specific objects and data regions in an HDF5 file.
    Returns:
    Returns an object type as defined in H5Gpublic.h; otherwise returns H5G_UNKNOWN. +
    Non-C API(s): +
    + @@ -257,7 +320,9 @@ H5R   HDF Help Desk
    -Last modified: 30 October 1998 +Last modified: 13 July 2000 +
    +Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.) diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index f0a14a4..4a26179 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -148,17 +148,15 @@ facilitate moving easily between them. -
    +
    General Datatype Operations - +
  • h5tcreate_f
  • h5topen_f
  • h5tcommit_f - +
  • h5tcommitted_f
  • h5tcopy_f - +
  • h5tequal_f -
    		•  -
  • h5tget_class_f
  • h5tget_size_f @@ -171,60 +169,60 @@ facilitate moving easily between them. -
    		•        -       -       +

    Atomic Datatype Properties -

  • h5tset_size_f
  • h5tget_order_f
  • h5tset_order_f - - - - - - - - - - - - +
  • h5tget_precision_f +
  • h5tset_precision_f +
  • h5tget_offset_f +
  • h5tset_offset_f +
    		•        +Atomic (continued) + +
  • h5tget_pad_f +
  • h5tset_pad_f +
  • h5tget_sign_f +
  • h5tset_sign_f +
  • h5tget_fields_f +
  • h5tset_fields_f +
  • h5tget_ebiass_f +
  • h5tset_ebiass_f - - - - - - - - +
  • h5tget_norm_f +
  • h5tset_norm_f +
  • h5tget_inpad_f +
  • h5tset_inpad_f +
  • h5tget_cset_f +
  • h5tset_cset_f +
  • h5tget_strpad_f +
  • h5tset_strpad_f - - - - - - - - - - - - - - - - - - - - - +
    		•        + Compound Datatype Properties +
  • h5tget_nmembers_f +
  • h5tget_member_name_f +
  • h5tget_member_offset_f +
  • h5tget_member_dims_f +
  • h5tget_member_type_f +
  • h5tinsert_f +
  • h5tpack_f +
  • h5tinsert_array_f +

    + Enumeration Datatypes +

  • h5tenum_create_f +
  • h5tenum_insert_f +
  • h5tenum_nameof_f +
  • h5tenum_valueof_f +
  • h5tget_member_value_f +

    + Opaque Datatypes +

  • h5tset_tag_f +
  • h5tget_tag_f
    • @@ -356,11 +354,10 @@ 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. - @@ -425,11 +422,10 @@ 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. - @@ -468,7 +464,7 @@ in the HDF5 User's Guide for further information, including a compl Otherwise returns NULL. @@ -692,7 +687,7 @@ H5Tget_overflow () otherwise returns a negative value. @@ -855,7 +849,7 @@ H5Tget_overflow () otherwise returns a negative value. @@ -1146,11 +1139,10 @@ H5Tget_overflow ()
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1221,11 +1213,10 @@ H5Tget_overflow ()
    Returns:
    Returns a positive offset value if successful; otherwise 0. - @@ -1306,11 +1297,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1352,11 +1342,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1395,11 +1384,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1431,11 +1419,10 @@ zero.
    Returns:
    Returns a valid sign type if successful; otherwise H5T_SGN_ERROR (-1). - @@ -1469,11 +1456,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1517,11 +1503,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1568,11 +1553,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1597,11 +1581,10 @@ zero.
    Returns:
    Returns the bias if successful; otherwise 0. - @@ -1629,11 +1612,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1667,11 +1649,10 @@ zero.
    Returns:
    Returns a valid normalization type if successful; otherwise H5T_NORM_ERROR (-1). - @@ -1708,11 +1689,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1747,11 +1727,10 @@ zero.
    Returns:
    Returns a valid padding type if successful; otherwise H5T_PAD_ERROR (-1). - @@ -1791,11 +1770,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1825,11 +1803,10 @@ zero.
    Returns:
    Returns a valid character set type if successful; otherwise H5T_CSET_ERROR (-1). - @@ -1865,11 +1842,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1901,11 +1877,10 @@ zero.
    Returns:
    Returns a valid string padding type if successful; otherwise H5T_STR_ERROR (-1). - @@ -1962,11 +1937,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -1991,11 +1965,10 @@ zero.
    Returns:
    Returns number of members datatype has if successful; otherwise returns a negative value. - @@ -2028,11 +2001,10 @@ zero.
    Returns:
    Returns a valid pointer if successful; otherwise NULL. - @@ -2066,11 +2038,10 @@ zero. Note that zero is a valid offset and that this function will fail only if a call to H5Tget_member_dims() fails with the same arguments. - @@ -2112,11 +2083,10 @@ zero.
    Returns the number of dimensions, a number from 0 to 4, if successful. Otherwise returns a negative value. - @@ -2146,11 +2116,10 @@ zero.
    Returns the identifier of a copy of the datatype of the field if successful; otherwise returns a negative value. - @@ -2192,11 +2161,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2222,11 +2190,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2305,7 +2272,7 @@ zero. otherwise returns a negative value. @@ -2412,11 +2378,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2462,11 +2427,10 @@ zero. and, if size allows it, the first character of name is set to NULL. - @@ -2503,11 +2467,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2543,11 +2506,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2576,11 +2538,10 @@ zero.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. - @@ -2609,11 +2570,10 @@ zero.
    Returns:
    Returns a pointer to an allocated string if successful; otherwise returns NULL. - @@ -2690,7 +2650,9 @@ H5T   HDF Help Desk
    -Last modified: 7 April 2000 +Last modified: 14 July 2000 +
    +Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.) -- cgit v0.12