Commit d6cb82ac by Christian Brauner Committed by GitHub

Merge pull request #1647 from 0x0916/update-api-doc

API doc: update note for get_config_item
parents 48836456 13a4215b
...@@ -408,8 +408,8 @@ struct lxc_container { ...@@ -408,8 +408,8 @@ struct lxc_container {
* \p retv by initially passing its value as \c NULL and considering the return value. * \p retv by initially passing its value as \c NULL and considering the return value.
* This function can then be called again passing a newly-allocated suitably-sized buffer. * This function can then be called again passing a newly-allocated suitably-sized buffer.
* \note If \p retv is NULL, \p inlen is ignored. * \note If \p retv is NULL, \p inlen is ignored.
* \note If \p inlen is smaller than required, the value written * \note If \p inlen is smaller than required, nothing will be written to \p retv and still return
* to \p retv will be truncated. * the length of config item value.
*/ */
int (*get_config_item)(struct lxc_container *c, const char *key, char *retv, int inlen); int (*get_config_item)(struct lxc_container *c, const char *key, char *retv, int inlen);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment