librados.h: update rados_object_list_next documentation for key/locator

*entry and *key don't need to be freed, and are only valid until the
next call to rados_objects_list_*.

Signed-off-by: Samuel Just <sam.just@inktank.com>
This commit is contained in:
Samuel Just 2012-05-29 10:30:51 -07:00
parent 73e29b658d
commit f953c4c0b0

View File

@ -601,9 +601,11 @@ int rados_objects_list_open(rados_ioctx_t io, rados_list_ctx_t *ctx);
/**
* Get the next object name and locator in the pool
*
* *entry and *key are valid until next call to rados_objects_list_*
*
* @param ctx iterator marking where you are in the listing
* @param entry where to store the name of the entry (caller must free)
* @param key where to store the object locator (set to NULL to ignore) (caller must free)
* @param entry where to store the name of the entry
* @param key where to store the object locator (set to NULL to ignore)
* @returns 0 on success, negative error code on failure
* @returns -ENOENT when there are no more objects to list
*/