CLI: Add lttng_trace_format_descriptor to lttng_session_extended

[lttng-tools.git] / include / lttng / session.h

diff --git a/include/lttng/session.h b/include/lttng/session.h
index 153a37b03680da361e97f0f64bdee979ae16c6fe..7ef03e54e253744da3c1b85971ed24d8ed58a700 100644 (file)
--- a/include/lttng/session.h
+++ b/include/lttng/session.h
@@ -208,6 +208,24 @@ LTTNG_EXPORT extern enum lttng_error_code lttng_session_get_creation_time(
 LTTNG_EXPORT extern int lttng_set_session_shm_path(const char *session_name,
                const char *shm_path);
 
+/*
+ * Get the trace format descriptor of an lttng_session object on the session daemon.
+ *
+ * This function must only be used with lttng_session objects returned
+ * by lttng_list_sessions() or lttng_session_create().
+ *
+ * The returned object is a copy of the session trace_format_descriptor for
+ * backward compatibility purpose.
+ *
+ * The returned object must be freed by using lttng_trace_format_descriptor_delete.
+ *
+ * Returns LTTNG_OK on success. See lttng-error.h for the meaning of the other
+ * return codes.
+ */
+LTTNG_EXPORT extern enum lttng_error_code lttng_session_get_trace_format_descriptor(
+               const struct lttng_session *session,
+               struct lttng_trace_format_descriptor **p_lttng_trace_format_descriptor);
+
 #ifdef __cplusplus
 }
 #endif