summaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
authorGerd Heber <gheber@hdfgroup.org>2020-11-10 15:11:49 (GMT)
committerGerd Heber <gheber@hdfgroup.org>2020-11-10 15:11:49 (GMT)
commit39eef14f0d9f27cac9a6a3f6a8de349f314e1b6a (patch)
tree4e55bf7d4d66999f8a1fd5ffd0cb95b8b17d7369 /doxygen
parent5189dfa0d9f8ed9395832b0f26938d14635debe2 (diff)
downloadhdf5-39eef14f0d9f27cac9a6a3f6a8de349f314e1b6a.zip
hdf5-39eef14f0d9f27cac9a6a3f6a8de349f314e1b6a.tar.gz
hdf5-39eef14f0d9f27cac9a6a3f6a8de349f314e1b6a.tar.bz2
Added 1.12.x function mappings.
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/dox/api-compat-macros.dox209
1 files changed, 205 insertions, 4 deletions
diff --git a/doxygen/dox/api-compat-macros.dox b/doxygen/dox/api-compat-macros.dox
index b420c75..c8c9d7a 100644
--- a/doxygen/dox/api-compat-macros.dox
+++ b/doxygen/dox/api-compat-macros.dox
@@ -281,14 +281,14 @@
</ul>
\warning Please be aware that some function mappings use mapped structures, as
- well. If compiling an application with a function mapping that uses
+ well. If compiling an application with a function mapping that uses
a mapped structure, you must include each function and mapped structure
plus EVERY function that uses the mapped structure, whether or not that
function is used in the application. \Emph{In 1.12, mappings of structures
are used by the H5L and H5O function mappings.}\n\n
- For example, an application only calls \Code{H5Lvisit}, \Code{H5Ovisit},
- and \Code{H5Oget_info_by_name}. To compile this application with 1.10 APIs
- in 1.12 with the function specific mappings, then not only must
+ For example, an application \Code{application.c} only calls \Code{H5Lvisit},
+ \Code{H5Ovisit}, and \Code{H5Oget_info_by_name}. To compile this application
+ with 1.10 APIs in 1.12 with the function specific mappings, then not only must
\Code{H5Lvisit_vers}, \Code{H5Ovisit_vers}, and \Code{H5Oget_info_by_name_vers}
be specified on the command line, but the mapped structures and every
function that uses the mapped structures must be included, as well.
@@ -302,6 +302,207 @@
\endcode
\subsubsection fun-options-112 Function Mapping Options in Releases 1.12.x
+ <table>
+ <tr>
+ <th style="text-align: left;">Macro<br/>(\Code{H5xxx})</th>
+ <th>Default function used if no macro specified
+ <ul><li>Function/struct mapping:\Code{H5xxx_vers=N}</li></ul>
+ </th>
+ <th>Function used if specifying 1.10
+ <ul><li>Function/struct mapping: \Code{H5xxx_vers=1}</li></ul>
+ </th>
+ </tr>
+ <tr>
+ <td>H5Lget_info()</td>
+ <td>H5Lget_info2()
+ <ul>
+ <li>Function mapping:\Code{H5Lget_info_vers=2}</li>
+ <li>Struct mapping:\Code{H5L_info_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Lget_info1()
+ <ul>
+ <li>Function mapping \Code{H5Lget_info_vers=1}</li>
+ <li>Struct mapping: \Code{H5L_info_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Lget_info_by_idx()</td>
+ <td>H5Lget_info_by_idx2()
+ <ul>
+ <li>Function mapping: \Code{H5Lget_info_by_idx_vers=2}</li>
+ <li>Struct mapping: \Code{H5L_info_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Lget_info_by_idx1()
+ <ul>
+ <li>Function mapping: \Code{H5Lget_info_by_idx_vers=1}</li>
+ <li>Struct mapping: \Code{H5L_info_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Literate()</td>
+ <td>H5Literate2()
+ <ul>
+ <li>Function mapping: \Code{H5Literate_vers=2}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Literate1()
+ <ul>
+ <li>Function mapping: \Code{H5Literate_vers=1}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Literate_by_name()</td>
+ <td>H5Literate_by_name2()
+ <ul>
+ <li>Function mapping: \Code{H5Literate_by_name_vers=2}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Literate_by_name1()
+ <ul>
+ <li>Function mapping: \Code{H5Literate_by_name_vers=1}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Lvisit()</td>
+ <td>H5Lvisit2()
+ <ul>
+ <li>Function mapping: \Code{H5Lvisit_vers=2}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Lvisit1()
+ <ul>
+ <li>Function mapping: \Code{H5Lvisit_vers=1}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Lvisit_by_name()</td>
+ <td>H5Lvisit_by_name2()
+ <ul>
+ <li>Function mapping: \Code{H5Lvisit_by_name_vers=2}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Lvisit_by_name1()
+ <ul>
+ <li>Function mapping: \Code{H5Lvisit_by_name_vers=1}</li>
+ <li>Struct mapping: \Code{H5L_iterate_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Oget_info()</td>
+ <td>H5Oget_info3()
+ <ul>
+ <li>Function mapping: \Code{H5Oget_info_vers=3}</li>
+ <li>Struct mapping: \Code{H5O_info_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Oget_info1()
+ <ul>
+ <li>Function mapping: \Code{H5Oget_info_vers=1}</li>
+ <li>Struct mapping: \Code{H5O_info_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Oget_info_by_idx()</td>
+ <td>H5Oget_info_by_idx3()
+ <ul><li>Function mapping: \Code{H5Oget_info_by_idx_vers=3}</li>
+ <li>Struct mapping: \Code{H5O_info_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Oget_info_by_idx1()
+ <ul>
+ <li>Function mapping: \Code{H5Oget_info_by_idx_vers=1}</li>
+ <li>Struct mapping: \Code{H5O_info_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Oget_info_by_name()</td>
+ <td>H5Oget_info_by_name3()
+ <ul>
+ <li>Function mapping: \Code{H5O_get_info_by_name_vers=3}</li>
+ <li>Struct mapping: \Code{H5O_info_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Oget_info_by_name1()
+ <ul>
+ <li>Function mapping: \Code{H5O_get_info_by_name_vers=1}</li>
+ <li>Struct mapping: \Code{H5O_info_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Ovisit()</td>
+ <td>H5Ovisit3()
+ <ul>
+ <li>Function mapping: \Code{H5Ovisit_vers=3}</li>
+ <li>Struct mapping: \Code{H5O_iterate_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Ovisit1()
+ <ul><li>Function mapping: \Code{H5Ovisit_vers=1}</li>
+ <li>Struct mapping: \Code{H5O_iterate_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Ovisit_by_name()</td>
+ <td>H5Ovisit_by_name3()
+ <ul>
+ <li>Function mapping: \Code{H5Ovisit_by_name_vers=3}</li>
+ <li>Struct mapping: \Code{H5O_iterate_t_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Ovisit_by_name1()
+ <ul>
+ <li>Function mapping: \Code{H5Ovisit_by_name_vers=1}</li>
+ <li>Struct mapping: \Code{H5O_iterate_t_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Pencode()</td>
+ <td>H5Pencode2()
+ <ul>
+ <li>Function mapping: \Code{H5Pencode_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Pencode1()
+ <ul>
+ <li>Function mapping: \Code{H5Pencode_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>H5Sencode()</td>
+ <td>H5Sencode2()
+ <ul>
+ <li>Function mapping: \Code{H5Sencode_vers=2}</li>
+ </ul>
+ </td>
+ <td>H5Sencode1()
+ <ul>
+ <li>Function mapping: \Code{H5Sencode_vers=1}</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+
\subsubsection fun-options-110 Function Mapping Options in Releases 1.10.x
\subsubsection fun-options-18 Function Mapping Options in Releases 1.8.x
\subsubsection further Further Information