summaryrefslogtreecommitdiffstats
path: root/doxygen/dox/H5Oget_info_by_name.dox
blob: 3276c5a6527b4445a31dcfda7c023c157bf867dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/**
 * \ingroup H5O
 * \def H5Oget_info_by_name()
 *
 * #H5Oget_info_by_name is a macro that is mapped to:
 * \li H5Oget_info_by_name3()
 * \li H5Oget_info_by_name1()
 *
 * \details Such macros are provided to facilitate application
 *          compatibility. Their use and mappings are fully described in
 *          API Compatibility Macros in HDF5; we urge you to read that
 *          document closely.
 *
 *          In HDF5 versions 1.12 and after, #H5Oget_info_by_name is mapped to
 *          \ref H5Oget_info_by_name3().  In version 1.10 #H5Oget_info_by_name is 
 *          identical to \ref H5Oget_info_by_name1(). 
 * 
 *          Specific compile-time compatibility flags and the resulting
 *          mappings are as follows:
 *
 * \par
 * <table>
 *  <tr>
 *      <th>Compatibility setting</th>
 *      <th>H5Oget_info_by_name</th>
 * </tr>
 *  <tr>
 *      <td>No compatibility flag</td>
 *      <td>\ref H5Oget_info_by_name3() for 1.12 and above</td>
 *  </tr>
 *  <tr>
        <td></td>
 *      <td>\ref H5Oget_info_by_name1() for 1.8 or 1.10</td>
 *  </tr>
 *  <tr>
 *      <td>Emulate Release 1.12</td>
 *      <td>\ref H5Oget_info_by_name3()</td>
 *  </tr>
 *  <tr>
 *      <td>Emulate Release 1.10 or 1.8 interface</td>
 *      <td>\ref H5Oget_info_by_name1()</td>
 *  </tr>
 * </table>
 *
 * \todo    Fix reference to the document; exchange 1.8.8 and 1.8.0
 *
 * \par Version
 * <table>
 * <tr>
 *      <th>Release</th>
 *      <th>Change</th>
 * </tr>
 *  <tr>
 *      <td>1.12.0</td>
 *      <td>The macro #H5Oget_info_by_name and function \ref H5Oget_info_by_name3() were added
 *          and \ref H5Oget_info_by_name1() was deprecated.</td>
 *  </tr>
 *  <tr>
 *      <td>1.10.5</td>
 *      <td>The macro #H5Oget_info_by_name was removed.</td>
 *  </tr>
 *  <tr>
 *      <td></td>
 *      <td>The functions \ref H5Oget_info_by_name() and
 *          H5Oget_info_by_name1() are identical in this release.</td>
 *  </tr>
 *  <tr>
 *      <td></td>
 *      <td>This change was added to restore the broken API compatibility 
 *          introduced in HDF5-1.10.3.</td>
 *  </tr>
 *  <tr>
 *      <td>1.10.3</td>
 *      <td>The function \ref H5Oget_info_by_name() was renamed 
 *          to \ref H5Oget_info_by_name1.</td>
 *  </tr>
 *  <tr>
 *      <td></td>
 *      <td>The macro #H5Oget_info_by_name was renamed to 
 *          \ref H5Oget_info_by_name1().</td>
 *  </tr>
 *  <tr>
 *      <td></td>
 *      <td>The macro #H5Oget_info_by_name and the function \ref H5Oget_info_name2() 
 *          were introduced in this release.</td>
 *  </tr>
 *  <tr>
 *      <td>1.8.8</td>
 *      <td>Fortran 2003 subroutine and \ref h5o_info_t derived 
 *          type introduced in this release.</td>
 *  </tr>
 *  <tr>
 *      <td>1.8.0</td>
 *      <td>C function introduced in this release.</td>
 *  </tr>
 * </table>
 *
 * 
 */