tep_get_event(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | EXAMPLE | FILES | SEE ALSO | AUTHOR | REPORTING BUGS | LICENSE | RESOURCES | NOTES | COLOPHON

LIBTRACEEVENT(3)          libtraceevent Manual          LIBTRACEEVENT(3)

NAME         top

       tep_get_event, tep_get_first_event, tep_get_events_count - Access
       events.

SYNOPSIS         top

       #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         top

       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         top

       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         top

           #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         top

           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         top

       libtraceevent(3), trace-cmd(1)

AUTHOR         top

           Steven Rostedt <[email protected][1]>, author of libtraceevent.
           Tzvetomir Stoyanov <[email protected][2]>, author of this man page.

REPORTING BUGS         top

       Report bugs to <[email protected][3]>

LICENSE         top

       libtraceevent is Free Software licensed under the GNU LGPL 2.1

RESOURCES         top

       https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/ 

NOTES         top

        1. [email protected]
           mailto:[email protected]

        2. [email protected]
           mailto:[email protected]

        3. [email protected]
           mailto:[email protected]

COLOPHON         top

       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 [email protected]

libtraceevent 1.7.3            09/24/2023               LIBTRACEEVENT(3)