X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fstream-class.h;h=64400f5201e794bf17c300ae6f66f60a4f664c3d;hb=03be3bcd6f3e4269f89672a418b5166ea343768f;hp=e66ab7da8d235471ab1dfc05fc9d4e992a041814;hpb=ef99818076ab38941a3c5bd70fc377f6b457d22f;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h index e66ab7da..64400f52 100644 --- a/include/babeltrace/ctf-ir/stream-class.h +++ b/include/babeltrace/ctf-ir/stream-class.h @@ -252,17 +252,20 @@ extern const char *bt_ctf_stream_class_get_name( /** @brief Sets the name of the CTF IR stream class - \p stream_class to \p name. + \p stream_class to \p name, or resets the name of + \p stream_class. -\p name must be unique amongst the names of all the stream classes -of the trace class to which you eventually add \p stream_class. +If \p name is not \c NULL, it must be unique amongst the names of all +the stream classes of the trace class to which you eventually add +\p stream_class. @param[in] stream_class Stream class of which to set the name. -@param[in] name Name of the stream class (copied on success). +@param[in] name Name of the stream class (copied on success), or + \c NULL to reset the name of \p stream_class + (make it unnamed). @returns 0 on success, or a negative value on error. @prenotnull{stream_class} -@prenotnull{name} @prehot{stream_class} @postrefcountsame{stream_class}