API Fix: bt_ctf_iter_read_event_flags

[babeltrace.git] / doc / API.txt

diff --git a/doc/API.txt b/doc/API.txt
index f1780f0a99f3156a52ed96d09973a01d8e570acf..bc3a4a10512e1aef477ee950de8a61d009250159 100644 (file)
--- a/doc/API.txt
+++ b/doc/API.txt
@@ -76,6 +76,14 @@ creation will return NULL. The previous iterator must be destroyed before
 creation of the new iterator. In the future, creation of multiples iterators
 will be allowed.
 
+The bt_ctf_iter_read_event_flags() function has the same behaviour as
+bt_ctf_iter_read_event() but takes an additionnal flag pointer. This flag is
+used to inform the user if a special condition occured while reading the event.
+As of now, only the BT_ITER_LOST_EVENTS is handled, it informs the user that
+some events were discarded by the tracer. To get the number of events lost
+immediately prior to the last event read, the user can call the
+bt_ctf_get_lost_events_count() function.
+
 Finally, we have the bt_ctf_get_iter() function which returns a struct bt_iter
 with which the iterator can be moved using one of these functions:
        bt_iter_next(),         moves the iterator to the next event
@@ -162,7 +170,9 @@ These functions give access to the value associated with a field :
        * bt_ctf_get_uint64();
        * bt_ctf_get_int64();
        * bt_ctf_get_char_array();
-       * bt_ctf_get_string().
+       * bt_ctf_get_string();
+       * bt_ctf_get_enum_int();
+       * bt_ctf_get_enum_str().
 
 If the field does not exist or is not of the type requested, the value returned
 with these four functions is undefined. To check if an error occured, use the