tools/lib/traceevent/Documentation/libtraceevent-event_get.txt

   1 libtraceevent(3)
   2 ================
   3
   4 NAME
   5 ----
   6 tep_get_event, tep_get_first_event, tep_get_events_count - Access events.
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 --
  12 *#include <event-parse.h>*
  13
  14 struct tep_event pass:[*]*tep_get_event*(struct tep_handle pass:[*]_tep_, int _index_);
  15 struct tep_event pass:[*]*tep_get_first_event*(struct tep_handle pass:[*]_tep_);
  16 int *tep_get_events_count*(struct tep_handle pass:[*]_tep_);
  17 --
  18
  19 DESCRIPTION
  20 -----------
  21 The _tep_get_event()_ function returns a pointer to event at the given _index_.
  22 The _tep_ argument is trace event parser context, the _index_ is the index of
  23 the requested event.
  24
  25 The _tep_get_first_event()_ function returns a pointer to the first event.
  26 As events are stored in an array, this function returns the pointer to the
  27 beginning of the array. The _tep_ argument is trace event parser context.
  28
  29 The _tep_get_events_count()_ function returns the number of the events
  30 in the array. The _tep_ argument is trace event parser context.
  31
  32 RETURN VALUE
  33 ------------
  34 The _tep_get_event()_ returns a pointer to the event located at _index_.
  35 NULL is returned in case of error, in case there are no events or _index_ is
  36 out of range.
  37
  38 The _tep_get_first_event()_ returns a pointer to the first event. NULL is
  39 returned in case of error, or in case there are no events.
  40
  41 The _tep_get_events_count()_ returns the number of the events. 0 is
  42 returned in case of error, or in case there are no events.
  43
  44 EXAMPLE
  45 -------
  46 [source,c]
  47 --
  48 #include <event-parse.h>
  49 ...
  50 struct tep_handle *tep = tep_alloc();
  51 ...
  52 int i,count = tep_get_events_count(tep);
  53 struct tep_event *event, *events = tep_get_first_event(tep);
  54
  55 if (events == NULL) {
  56         /* There are no events */
  57 } else {
  58         for (i = 0; i < count; i++) {
  59                 event = (events+i);
  60                 /* process events[i] */
  61         }
  62
  63         /* Get the last event */
  64         event = tep_get_event(tep, count-1);
  65 }
  66 --
  67
  68 FILES
  69 -----
  70 [verse]
  71 --
  72 *event-parse.h*
  73         Header file to include in order to have access to the library APIs.
  74 *-ltraceevent*
  75         Linker switch to add when building a program that uses the library.
  76 --
  77
  78 SEE ALSO
  79 --------
  80 _libtraceevent(3)_, _trace-cmd(1)_
  81
  82 AUTHOR
  83 ------
  84 [verse]
  85 --
  86 *Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
  87 *Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
  88 --
  89 REPORTING BUGS
  90 --------------
  91 Report bugs to  <linux-trace-devel@vger.kernel.org>
  92
  93 LICENSE
  94 -------
  95 libtraceevent is Free Software licensed under the GNU LGPL 2.1
  96
  97 RESOURCES
  98 ---------
  99 https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git