diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2019-02-15 01:27:02 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2019-02-15 01:27:02 (GMT) |
| commit | dcf93b3ec54c8ebc158cd7a2b645ad62b1fa8f2a (patch) | |
| tree | 4686c844eeada7ffbb0970a4dc9218c1fa1a9a8f | |
| parent | 268128e5202366dbea1f9a00ebcbed30a62ea674 (diff) | |
| download | hdf5-dcf93b3ec54c8ebc158cd7a2b645ad62b1fa8f2a.zip hdf5-dcf93b3ec54c8ebc158cd7a2b645ad62b1fa8f2a.tar.gz hdf5-dcf93b3ec54c8ebc158cd7a2b645ad62b1fa8f2a.tar.bz2 | |
Adding documentation
Description
Added detail about the argument "fields" of H5Object::visit.
| -rw-r--r-- | c++/src/H5Object.cpp | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/c++/src/H5Object.cpp b/c++/src/H5Object.cpp index 03558e9..e8cec97 100644 --- a/c++/src/H5Object.cpp +++ b/c++/src/H5Object.cpp @@ -252,7 +252,13 @@ int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_dat ///\param *op_data - IN: User-defined pointer to data required by the /// application for its processing of the object ///\param fields - IN: Flags specifying the fields to be retrieved -/// to the callback op +/// to the callback op via the H5O_info_t argument. +/// \li \c H5O_INFO_BASIC fileno, addr, type, and rc fields +/// \li \c H5O_INFO_TIME atime, mtime, ctime, and btime fields +/// \li \c H5O_INFO_NUM_ATTRS num_attrs field +/// \li \c H5O_INFO_HDR hdr field +/// \li \c H5O_INFO_META_SIZE meta_size field +/// \li \c H5O_INFO_ALL H5O_INFO_BASIC | H5O_INFO_TIME | H5O_INFO_NUM_ATTRS | H5O_INFO_HDR | H5O_INFO_META_SIZE ///\return /// \li On success: /// \li the return value of the first operator that returns a positive value |