hdf5/doxygen/dox/H5Oget_info_by_idx.dox
2020-11-03 10:42:09 -06:00

93 lines
2.6 KiB
Plaintext

/**
* \ingroup H5O
* \def H5Oget_info_by_idx()
*
* #H5Oget_info_by_idx is a macro that is mapped to:
* \li H5Oget_info_by_idx3()
* \li H5Oget_info_by_idx1()
*
* \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_idx is mapped to
* \ref H5Oget_info_by_idx3() and \ref H5Oget_info_by_idx1() is deprecated.
* In version 1.10 #H5Oget_info_by_idx is identical to \ref H5Oget_info_by_idx1().
*
* Specific compile-time compatibility flags and the resulting
* mappings are as follows:
*
* \par
* <table>
* <tr>
* <th>Compatibility setting</th>
* <th>H5Oget_info_by_idx</th>
* </tr>
* <tr>
* <td>No compatibility flag</td>
* <td>\ref H5Oget_info_by_idx3() for 1.12</td>
* </tr>
* <tr>
<td></td>
* <td>\ref H5Oget_info_by_idx1() for 1.8/1.10</td>
* </tr>
* <tr>
* <td>Emulate Release 1.12</td>
* <td>\ref H5Oget_info_by_idx3()</td>
* </tr>
* <tr>
* <td>Emulate Release 1.10/1.8 interface</td>
* <td>\ref H5Oget_info_by_idx1()</td>
* </tr>
* </table>
*
* \todo Fix reference to the document
*
* \par Version
* <table>
* <tr>
* <th>Release</th>
* <th>Change</th>
* </tr>
* <tr>
* <td>1.12.0</td>
* <td>The macro #H5Oget_info_by_idx and function \ref H5Oget_info_by_idx3() were added,
* and \ref H5Oget_info_by_idx1() was deprecated.</td>
* </tr>
* <tr>
* <td>1.10.5</td>
* <td>The macro #H5Oget_info_by_idx was removed.</td>
* </tr>
* <tr>
* <td></td>
* <td>The functions \ref H5Oget_info_by_idx() and
* H5Oget_info_by_idx1() 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_idx() was renamed \ref H5Oget_info_by_idx1.</td>
* </tr>
* <tr>
* <td></td>
* <td>The macro #H5Oget_info_by_idx and the function \ref H5Oget_info_by_idx2() were
* introduced in this release.</td>
* </tr>
* <tr>
* <td>1.8.11</td>
* <td>Fortran subroutine introduced in this release.</td>
* </tr>
* <tr>
* <td>1.8.0</td>
* <td>Function introduced in this release.</td>
* </tr>
* </table>
*
*
*/