Events group. More...
Collaboration diagram for Events:
Macros | |
| #define | __itt_event_create __itt_event_createA |
| #define | __itt_event_create_ptr __itt_event_createA_ptr |
Typedefs | |
| typedef int | __itt_event |
| user event type | |
Functions | |
| __itt_event LIBITTAPI | __itt_event_createA (const char *name, int namelen) |
| Create an event notification. | |
| __itt_event LIBITTAPI | __itt_event_createW (const wchar_t *name, int namelen) |
| int LIBITTAPI | __itt_event_start (__itt_event event) |
| Record an event occurrence. | |
| int LIBITTAPI | __itt_event_end (__itt_event event) |
| Record an event end occurrence. | |
Detailed Description
Events group.
Macro Definition Documentation
◆ __itt_event_create
| #define __itt_event_create __itt_event_createA |
Definition at line 687 of file ittnotify.h.
◆ __itt_event_create_ptr
| #define __itt_event_create_ptr __itt_event_createA_ptr |
Definition at line 688 of file ittnotify.h.
Typedef Documentation
◆ __itt_event
| typedef int __itt_event |
user event type
Definition at line 672 of file ittnotify.h.
Function Documentation
◆ __itt_event_createA()
| __itt_event LIBITTAPI __itt_event_createA | ( | const char * | name, |
| int | namelen | ||
| ) |
Create an event notification.
- Note
- name or namelen being null/name and namelen not matching, user event feature not enabled
- Returns
- non-zero event identifier upon success and __itt_err otherwise
◆ __itt_event_createW()
| __itt_event LIBITTAPI __itt_event_createW | ( | const wchar_t * | name, |
| int | namelen | ||
| ) |
◆ __itt_event_end()
| int LIBITTAPI __itt_event_end | ( | __itt_event | event | ) |
Record an event end occurrence.
- Note
- It is optional if events do not have durations.
- Returns
- __itt_err upon failure (invalid event id/user event feature not enabled)
◆ __itt_event_start()
| int LIBITTAPI __itt_event_start | ( | __itt_event | event | ) |
Record an event occurrence.
- Returns
- __itt_err upon failure (invalid event id/user event feature not enabled)
