X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=doc%2FAPI.txt;h=bc3a4a10512e1aef477ee950de8a61d009250159;hp=5c06198ec1f3a721414fd221cdf089db143ff82c;hb=f60efc0e475b3c2fca3b2afc584615f6c482c9e7;hpb=c22b9327cbc4e6d9053f998952ea71c3227b8e36

diff --git a/doc/API.txt b/doc/API.txt
index 5c06198e..bc3a4a10 100644
--- 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