Fix: complete error handling of babeltrace API

[babeltrace.git] / include / babeltrace / ctf / iterator.h

diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h
index 71f935a0fe581c557ea8e3585b19c9fcde763de9..fe70b5e732258e5a245e151a7a259eb7eaf237f8 100644 (file)
--- a/include/babeltrace/ctf/iterator.h
+++ b/include/babeltrace/ctf/iterator.h
@@ -39,6 +39,13 @@ struct bt_ctf_event;
  * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
  * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
  * trace) is the EOF criterion.
+ *
+ * Return a pointer to the newly allocated iterator.
+ *
+ * Only one iterator can be created against a context. If more than one
+ * iterator is being created for the same context, the second creation
+ * will return NULL. The previous iterator must be destroyed before
+ * creation of the new iterator for this function to succeed.
  */
 struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
                const struct bt_iter_pos *begin_pos,
@@ -57,7 +64,7 @@ void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
 /*
  * bt_ctf_iter_read_event: Read the iterator's current event data.
  *
- * @iter: trace collection iterator (input)
+ * @iter: trace collection iterator (input). Should NOT be NULL.
  *
  * Return current event on success, NULL on end of trace.
  */