Cleanup (messages): Make the wording of the signedness warning clearer

[babeltrace.git] / include / babeltrace / trace-handle.h

diff --git a/include/babeltrace/trace-handle.h b/include/babeltrace/trace-handle.h
index d188cb70f8367eefa6dab74be5842dc9c4e5d6f4..4c85b670ce05ac05906fef846704dabf71ae2b0e 100644 (file)
--- a/include/babeltrace/trace-handle.h
+++ b/include/babeltrace/trace-handle.h
@@ -31,22 +31,31 @@
  * It is a unique identifier representing a trace file.
  */
 struct bt_trace_handle;
+struct bt_ctf_event;
 
 /*
- * bt_trace_handle_get_path : returns the path of a trace_handle.
+ * bt_trace_handle_get_path : returns the path of a trace_handle or NULL
+ * on error.
  */
 const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
 
 /*
- * bt_trace_handle_get_timestamp_begin : returns the beginning timestamp
- * of a trace.
+ * bt_trace_handle_get_timestamp_begin : returns the creation time of the buffers
+ * of a trace or -1ULL on error.
  */
 uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, int handle_id);
 
 /*
- * bt_trace_handle_get_timestamp_end : returns the end timestamp of a
- * trace.
+ * bt_trace_handle_get_timestamp_end : returns the destruction timestamp of the
+ * buffers of a trace or -1ULL on error.
  */
 uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id);
 
+/*
+ * bt_ctf_event_get_handle_id : get the handle id associated with an event
+ *
+ * Returns -1 on error
+ */
+int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
+
 #endif /* _BABELTRACE_TRACE_HANDLE_H */