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

24 lines
1.2 KiB
Plaintext

/**
* \ingroup TRAV
* \def H5Literate_by_name()
* H5Literate_by_name() is a macro that is mapped to either
* H5Literate_by_name1() or H5Literate_by_name2() Such macros are provided to
* facilitate application compatibility. Their use and mappings are fully
* described in Compatibility Macros in HDF5. If the library and/or application is
* compiled for Release 1.12 emulation, H5Literate_by_name() will be mapped to
* H5Literate_by_name2() and H5Literate_by_name1() is deprecated. With earlier
* versions, H5Literate_by_name() is mapped to H5Literate_by_name1().
* Specific compile-time compatibility flags and the resulting mappings are as
* follows:
* \li No compatibility flag: H5Literate_by_name2() (using 1.12 source)
* H5Literate_by_name1() (using 1.10 or 1.8 source)
* \li Emulate Release 1.12: H5Literate_by_name2()
* \li Emulate Release 1.8 or 1.10 interface: H5Literate_by_name1()
*
* \todo Fix the reference.
*
* \version 1.12.0 The function H5Literate_by_name() was renamed to H5Literate_by_name1() and
* deprecated in this release. The macro H5Literate_by_name() and the
* function H5Literate_by_name2() were introduced in this release.
*/