API : add_trace return the trace_handle id

[babeltrace.git] / include / babeltrace / context.h

diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h
index 32282cf4cc7acb7f91e275da6bbb7f852257751a..261c4d47b625c6aa70382ba93ba02389dc9e5003 100644 (file)
--- a/include/babeltrace/context.h
+++ b/include/babeltrace/context.h
@@ -41,7 +41,8 @@ struct bt_context *bt_context_create(void);
  *
  * Open a trace
  *
- * Return: 0 on success, nonzero on failure.
+ * Return: the trace handle id (>= 0) on success, a negative
+ * value on error.
  */
 int bt_context_add_trace(struct bt_context *ctx, const char *path,
                const char *format);