tep_get_event(3) — Linux manual page
LIBTRACEEVENT(3) libtraceevent Manual LIBTRACEEVENT(3)
NAME
tep_get_event, tep_get_first_event, tep_get_events_count - Access
events.
SYNOPSIS
#include <event-parse.h>
struct tep_event *tep_get_event(struct tep_handle *tep, int index);
struct tep_event *tep_get_first_event(struct tep_handle *tep);
int tep_get_events_count(struct tep_handle *tep);
DESCRIPTION
The tep_get_event() function returns a pointer to event at the
given index. The tep argument is trace event parser context, the
index is the index of the requested event.
The tep_get_first_event() function returns a pointer to the first
event. As events are stored in an array, this function returns
the pointer to the beginning of the array. The tep argument is
trace event parser context.
The tep_get_events_count() function returns the number of the
events in the array. The tep argument is trace event parser
context.
RETURN VALUE
The tep_get_event() returns a pointer to the event located at
index. NULL is returned in case of error, in case there are no
events or index is out of range.
The tep_get_first_event() returns a pointer to the first event.
NULL is returned in case of error, or in case there are no
events.
The tep_get_events_count() returns the number of the events. 0 is
returned in case of error, or in case there are no events.
EXAMPLE
#include <event-parse.h>
...
struct tep_handle *tep = tep_alloc();
...
int i,count = tep_get_events_count(tep);
struct tep_event *event, *events = tep_get_first_event(tep);
if (events == NULL) {
/* There are no events */
} else {
for (i = 0; i < count; i++) {
event = (events+i);
/* process events[i] */
}
/* Get the last event */
event = tep_get_event(tep, count-1);
}
FILES
event-parse.h
Header file to include in order to have access to the library APIs.
-ltraceevent
Linker switch to add when building a program that uses the library.
SEE ALSO
libtraceevent(3), trace-cmd(1)
AUTHOR
Steven Rostedt <rostedt@goodmis.org[1]>, author of libtraceevent.
Tzvetomir Stoyanov <tz.stoyanov@gmail.com[2]>, author of this man page.
REPORTING BUGS
Report bugs to <linux-trace-devel@vger.kernel.org[3]>
LICENSE
libtraceevent is Free Software licensed under the GNU LGPL 2.1
RESOURCES
https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
NOTES
1. rostedt@goodmis.org
mailto:rostedt@goodmis.org
2. tz.stoyanov@gmail.com
mailto:tz.stoyanov@gmail.com
3. linux-trace-devel@vger.kernel.org
mailto:linux-trace-devel@vger.kernel.org
COLOPHON
This page is part of the libtraceevent (Linux kernel trace event
library) project. Information about the project can be found at
⟨https://www.trace-cmd.org/⟩. If you have a bug report for this
manual page, see ⟨https://www.trace-cmd.org/⟩. This page was
obtained from the project's upstream Git repository
⟨https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git⟩
on 2024-06-14. (At that time, the date of the most recent commit
that was found in the repository was 2024-05-17.) If you
discover any rendering problems in this HTML version of the page,
or you believe there is a better or more up-to-date source for
the page, or you have corrections or improvements to the
information in this COLOPHON (which is not part of the original
manual page), send a mail to man-pages@man7.org