Fix: check if handle is valid

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

diff --git a/include/babeltrace/trace-handle.h b/include/babeltrace/trace-handle.h
index 65171e7090cfd1574db20874c753ae2e3281b0c2..4c85b670ce05ac05906fef846704dabf71ae2b0e 100644 (file)
--- a/include/babeltrace/trace-handle.h
+++ b/include/babeltrace/trace-handle.h
@@ -34,19 +34,20 @@ 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 creation time of the buffers
- * of a trace.
+ * 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 destruction timestamp of the
- * buffers of a trace.
+ * buffers of a trace or -1ULL on error.
  */
 uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id);