rpma_mr_get_ptr(3)

📦
version 1.3.0 · 3 versions
, in ubuntu noble

✨ rpma_mr_get_ptr ✨

okay bestie, welcome to librpma land 💖 this is a page from the RPMA Programmer's Manual, and today's main character is rpma_mr_get_ptr — the lil function that gets you the pointer to your local memory region. yes, that pointer. the one you've been looking for. 🫶

🌸 NAME 🌸

rpma_mr_get_ptr — get the pointer to the local memory region 💅

🎀 SYNOPSIS 🎀

#include <librpma.h>

struct rpma_mr_local;
int rpma_mr_get_ptr(const struct rpma_mr_local *mr, void **ptr);

🦋 DESCRIPTION 🦋

so like, rpma_mr_get_ptr() does one thing and it does it well: it gets a memory region pointer from the local memory registration object. that's it. that's the whole vibe. 🧚

⭐ RETURN VALUE ⭐

rpma_mr_get_ptr() returns 0 on success — slay — or a negative error code on failure. 😭

and no cap: on failure, rpma_mr_get_ptr() does not set the *ptr value. it just leaves it alone. don't be out here trusting *ptr after an L, bestie. 💀

🔥 ERRORS 🔥

rpma_mr_get_ptr() can fail with the following error:

  • RPMA_E_INVAL — mr or ptr is NULL. like, you gave it nothing. it cannot work with nothing. 🙈

👑 SEE ALSO 👑

and that's the tea ☕ this was the RPMA manual, dated 01 April 2024 — go forth and get those pointers, you iconic icon. periodt. 💜🌈✨

📦 where this page comes from