UMAD_GET_PKEY(3)

💖 UMAD_GET_PKEY 💖

okay bestie, welcome to section 3 of the OpenIB Programmer's Manual — yes the OpenIB one, we're fancy here 💅 this is the page for umad_get_pkey, and it is so much shorter than you're expecting. a little snack. a lil treat. let's go 🦋

✨ NAME ✨

umad_get_pkey — grab the pkey index out of a umad buffer 🎀

🌸 SYNOPSIS 🌸

#include <infiniband/umad.h>

int umad_get_pkey(void *umad);

like. that's the whole thing. no cap. 🌈

💜 DESCRIPTION 💜

so umad_get_pkey() does exactly one (1) job and it does it flawlessly, as it should: it gets the pkey index out of the umad buffer you hand it. that's it. that's the function. main character energy with zero side quests 👑

you pass in umad — that's your void pointer to the buffer, bestie — and it goes and finds the pkey index for you. obsessed. ✨

⭐ RETURN VALUE ⭐

• umad_get_pkey() returns the value of the pkey index 💖
• ...or it returns zero if the pkey index isn't supported by the user_mad interface 🫶

heads up girlypop: zero is doing double duty here. it's a legit return value and the "not supported" signal. so don't go assuming zero always means zero, iykyk 😭

👑 AUTHOR 👑

this icon was written by Sasha Khapyorsky <sashak@voltaire.com> — say thank you 💐

and that's the whole page, fr fr. short, sweet, slays. 🌸

OpenIB · Jan 15, 2008 — yeah she's been iconic since 2008 and she's still serving 💅💖 bye bestie!! 🦋✨