'\" t
.\"     Title: libtraceevent
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2024
.\"    Manual: libtraceevent Manual
.\"    Source: libtraceevent 1.8.2
.\"  Language: English
.\"
.TH "LIBTRACEEVENT" "3" "01/14/2024" "libtraceevent 1\&.8\&.2" "libtraceevent Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tep_list_events, tep_list_events_copy \- Get list of events, sorted by given criteria\&.
.SH "SYNOPSIS"
.sp
.nf
\fB#include <event\-parse\&.h>\fR

enum \fBtep_event_sort_type\fR {
        \fITEP_EVENT_SORT_ID\fR,
        \fITEP_EVENT_SORT_NAME\fR,
        \fITEP_EVENT_SORT_SYSTEM\fR,
};

struct tep_event **\fBtep_list_events\fR(struct tep_handle *\fItep\fR, enum tep_event_sort_type \fIsort_type\fR);
struct tep_event **\fBtep_list_events_copy\fR(struct tep_handle *\fItep\fR, enum tep_event_sort_type \fIsort_type\fR);
.fi
.SH "DESCRIPTION"
.sp
The \fBtep_list_events()\fR function returns an array of pointers to the events, sorted by the \fIsort_type\fR criteria\&. The last element of the array is NULL\&. The returned memory must not be freed, it is managed by the library\&. The function is not thread safe\&. The \fItep\fR argument is trace event parser context\&. The \fIsort_type\fR argument is the required sort criteria:
.sp
.if n \{\
.RS 4
.\}
.nf
        \fITEP_EVENT_SORT_ID\fR     \- sort by the event ID\&.
        \fITEP_EVENT_SORT_NAME\fR   \- sort by the event (name, system, id) triplet\&.
        \fITEP_EVENT_SORT_SYSTEM\fR \- sort by the event (system, name, id) triplet\&.
.fi
.if n \{\
.RE
.\}
.sp
The \fBtep_list_events_copy()\fR is a thread safe version of \fItep_list_events()\fR\&. It has the same behavior, but the returned array is allocated internally and must be freed by the caller\&. Note that the content of the array must not be freed (see the EXAMPLE below)\&.
.SH "RETURN VALUE"
.sp
The \fBtep_list_events()\fR function returns an array of pointers to events\&. In case of an error, NULL is returned\&. The returned array must not be freed, it is managed by the library\&.
.sp
The \fBtep_list_events_copy()\fR function returns an array of pointers to events\&. In case of an error, NULL is returned\&. The returned array must be freed by the caller\&.
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
#include <event\-parse\&.h>
\&.\&.\&.
struct tep_handle *tep = tep_alloc();
\&.\&.\&.
int i;
struct tep_event_format **events;

i=0;
events = tep_list_events(tep, TEP_EVENT_SORT_ID);
if (events == NULL) {
        /* Failed to get the events, sorted by ID */
} else {
        while(events[i]) {
                /* walk through the list of the events, sorted by ID */
                i++;
        }
}

i=0;
events = tep_list_events_copy(tep, TEP_EVENT_SORT_NAME);
if (events == NULL) {
        /* Failed to get the events, sorted by name */
} else {
        while(events[i]) {
                /* walk through the list of the events, sorted by name */
                i++;
        }
        free(events);
}

\&.\&.\&.
.fi
.if n \{\
.RE
.\}
.SH "FILES"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBevent\-parse\&.h\fR
        Header file to include in order to have access to the library APIs\&.
\fB\-ltraceevent\fR
        Linker switch to add when building a program that uses the library\&.
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fBlibtraceevent\fR(3), \fBtrace\-cmd\fR(1)
.SH "AUTHOR"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBSteven Rostedt\fR <\m[blue]\fBrostedt@goodmis\&.org\fR\m[]\&\s-2\u[1]\d\s+2>, author of \fBlibtraceevent\fR\&.
\fBTzvetomir Stoyanov\fR <\m[blue]\fBtz\&.stoyanov@gmail\&.com\fR\m[]\&\s-2\u[2]\d\s+2>, author of this man page\&.
.fi
.if n \{\
.RE
.\}
.SH "REPORTING BUGS"
.sp
Report bugs to <\m[blue]\fBlinux\-trace\-devel@vger\&.kernel\&.org\fR\m[]\&\s-2\u[3]\d\s+2>
.SH "LICENSE"
.sp
libtraceevent is Free Software licensed under the GNU LGPL 2\&.1
.SH "RESOURCES"
.sp
\m[blue]\fBhttps://git\&.kernel\&.org/pub/scm/libs/libtrace/libtraceevent\&.git/\fR\m[]
.SH "NOTES"
.IP " 1." 4
rostedt@goodmis.org
.RS 4
\%mailto:rostedt@goodmis.org
.RE
.IP " 2." 4
tz.stoyanov@gmail.com
.RS 4
\%mailto:tz.stoyanov@gmail.com
.RE
.IP " 3." 4
linux-trace-devel@vger.kernel.org
.RS 4
\%mailto:linux-trace-devel@vger.kernel.org
.RE