XDF_GET_EVENT(3)

💖 XDF_GET_EVENT(3) 💖

okay bestie, welcome to the xdffileio library manual — yes this is a C thing, yes it's real, and yes you're gonna get it. this is xdf_get_event, and it's about to spill the tea on your data file's events. 🎀

✨ NAME ✨

xdf_get_event — get the deets of an event in a data file. like, the actual details. not vibes. details. 💅

🦋 SYNOPSIS 🦋

#include <xdfio.h>

int xdf_get_event(struct xdf* xdf, unsigned int index,
                  int* evttype, double* onset, double* dur);

look at that signature. she's giving structured. 😌

🌸 DESCRIPTION 🌸

so here's the situation, bestie: xdf_get_event() hands you back the info for the index-th event of the file that the handle xdf is pointing at. that's it. that's the whole job. 🫶

and it doesn't just dump everything in one blob — no no, she's organized. she writes the results into three separate pointers, so:

• the event type goes to evttype
• the start of the event, in seconds goes to onset
• the duration of the event, also in seconds goes to dur

three pointers, three answers, zero confusion. we love a clean interface. ✨

🔥 RETURN VALUE 🔥

• she returns 0 when everything slays — success, periodt. 👑
• if it doesn't go well, she returns -1 and sets errno appropriately. so like, check your errno, bestie. she's trying to tell you something. 😭

💀 ERRORS 💀

• EINVAL — one of xdf, evttype, onset or dur is NULL. yeah. you passed a whole void. not the vibe. 🙈
• ERANGE — index is bigger than the number of events in the file. you're reaching for an event that literally does not exist. it's not there. stop asking. 💀

🧚 SEE ALSO 🧚

• xdf_add_evttype(3) — go read that one too, iykyk 🌈

and that's the whole page, bestie! this gorgeous piece of documentation was brought to you by EPFL in 2010, and the page itself is XDF_GET_EVENT(3). stan an institution that ships manpages. 💜