diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 34f5e51187..ec03ac9ef7 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -266,10 +266,20 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -298,10 +308,24 @@ of the HDF5 User's Guide..
Returns:
Returns a dataspace identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -330,10 +354,26 @@ of the HDF5 User's Guide..
Returns:
Returns a dataspace identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -385,10 +425,26 @@ of the HDF5 User's Guide..
Returns:
Returns a dataspace identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -421,10 +477,23 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -473,11 +542,17 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + @@ -504,10 +579,24 @@ of the HDF5 User's Guide..
Returns:
Returns the number of element points in the current dataspace selection if successful. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -563,10 +652,27 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -623,10 +729,28 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -654,10 +778,23 @@ of the HDF5 User's Guide..
Returns the number of hyperslab blocks in the current dataspace selection if successful. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -683,10 +820,23 @@ of the HDF5 User's Guide..
Returns:
Returns the number of elements in the selection if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -737,10 +887,28 @@ of the HDF5 User's Guide.. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -781,10 +949,27 @@ of the HDF5 User's Guide..
Returns:
Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -810,10 +995,23 @@ of the HDF5 User's Guide..
Returns:
Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -840,10 +1038,24 @@ of the HDF5 User's Guide..
Returns:
Returns the number of elements in the dataspace if successful; otherwise returns 0. -
Non-C API(s): -
- @@ -874,10 +1086,27 @@ of the HDF5 User's Guide..
Returns:
Returns a dataspace class name if successful; otherwise H5S_NO_CLASS (-1). -
Non-C API(s): -
- @@ -905,10 +1134,24 @@ of the HDF5 User's Guide..
When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -946,10 +1189,24 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -981,10 +1238,20 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1061,10 +1328,31 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1198,10 +1486,36 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1228,10 +1542,20 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1261,10 +1585,23 @@ of the HDF5 User's Guide.. or 0 (zero), for FALSE, if it is not. Returns a negative value on error conditions such as the selection or extent not being defined. -
Non-C API(s): -
- @@ -1291,10 +1628,22 @@ of the HDF5 User's Guide..
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1343,10 +1692,30 @@ of the HDF5 User's Guide..
Returns:
Returns a dataspace identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 6600de3aad..44e26595cd 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -434,10 +434,25 @@ 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): -
- @@ -465,10 +480,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): -
- @@ -504,10 +529,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): -
- @@ -540,10 +578,20 @@ 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): -
- @@ -601,11 +649,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. + + @@ -697,10 +751,22 @@ 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): -
- @@ -742,10 +808,25 @@ 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): -
- @@ -784,10 +865,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. - + + @@ -815,10 +904,24 @@ 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): -
- @@ -861,10 +964,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): -
- @@ -911,10 +1026,24 @@ 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): -
- @@ -952,10 +1081,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): -
- @@ -987,10 +1128,24 @@ 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): -
- @@ -1028,11 +1183,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. + + @@ -1070,10 +1231,20 @@ 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): -
- @@ -1101,10 +1272,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): -
- @@ -1144,10 +1325,32 @@ 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): -
- @@ -1178,10 +1381,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): -
- @@ -1207,10 +1423,22 @@ in the HDF5 User's Guide for further information, including a compl
Returns:
Returns the bias if successful; otherwise 0. -
Non-C API(s): -
- @@ -1255,10 +1483,25 @@ 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): -
- @@ -1294,10 +1537,28 @@ 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): -
- @@ -1329,12 +1590,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. - + @@ -1371,12 +1636,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. - @@ -1419,10 +1689,25 @@ 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): -
- @@ -1457,10 +1742,24 @@ 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): -
- @@ -1491,10 +1790,24 @@ 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): -
- @@ -1531,10 +1844,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): -
- @@ -1619,11 +1945,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. + + @@ -1651,10 +1983,22 @@ 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): -
- @@ -1689,10 +2033,27 @@ 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): -
- @@ -1764,10 +2125,23 @@ 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): -
- @@ -1804,10 +2178,26 @@ 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): -
- @@ -1838,11 +2228,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. + + @@ -1885,10 +2281,32 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1916,10 +2334,22 @@ H5Tget_overflow ()
Returns:
Returns the number of significant bits if successful; otherwise 0. -
Non-C API(s): -
- @@ -1952,10 +2382,27 @@ H5Tget_overflow ()
Returns:
Returns a valid sign type if successful; otherwise H5T_SGN_ERROR (-1). -
Non-C API(s): -
- @@ -1981,10 +2428,22 @@ H5Tget_overflow ()
Returns:
Returns the size of the datatype in bytes if successful; otherwise 0. -
Non-C API(s): -
- @@ -2012,10 +2471,26 @@ H5Tget_overflow ()
Returns:
Returns a valid string storage mechanism if successful; otherwise H5T_STR_ERROR (-1). -
Non-C API(s): -
- @@ -2044,10 +2519,22 @@ H5Tget_overflow ()
Returns:
Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2077,10 +2564,24 @@ H5Tget_overflow ()
Returns:
Returns a pointer to an allocated string if successful; otherwise returns NULL. -
Non-C API(s): -
- @@ -2123,10 +2624,25 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2156,10 +2672,24 @@ H5Tget_overflow ()
Returns:
Returns TRUE or FALSE if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2190,11 +2720,17 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + @@ -2227,10 +2763,24 @@ H5Tget_overflow ()
Returns:
Returns a named datatype identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2257,10 +2807,21 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2354,11 +2915,17 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + @@ -2395,10 +2962,24 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2427,10 +3008,24 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2478,10 +3073,25 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2522,10 +3132,25 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2563,10 +3188,27 @@ H5Tget_overflow ()
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2648,10 +3290,23 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2689,10 +3344,26 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2730,11 +3401,17 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + @@ -2774,10 +3451,31 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2816,10 +3514,22 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2838,15 +3548,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. +
Parameters: -
-
hid_t type_id +
+
hid_t type_id
Identifier of datatype to set.
H5T_sign_t sign
Sign type. @@ -2854,10 +3564,27 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2897,10 +3624,23 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2958,10 +3698,25 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -2992,10 +3747,23 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -3024,11 +3792,17 @@ zero.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + @@ -3068,10 +3842,22 @@ zero.
Returns:
Returns datatype identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index 542b744631..3a2c7eac87 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -173,10 +173,25 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -379,11 +394,17 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + @@ -413,10 +434,23 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
-