MONGOC_OIDC_CA...S_GET_USERNAME(3)

📦
version 2.5.6 · 3 versions
, in epel 10

💅 MONGOC_OIDC_CALLBACK_PARAMS_GET_USERNAME(3) 💅

okay so bestie, welcome to libmongoc — yes this is a real function in it, and yes the man page title is literally abbreviated to MONGOC_OIDC_CA...S_GET_USERNAME(3) because the full name is so long it ate the entire header line. iconic behavior, honestly.

✨ SYNOPSIS ✨

const char *
mongoc_oidc_callback_params_get_username (const mongoc_oidc_callback_params_t *params);

So what does it do? It returns the username component of the URI of an associated mongoc_client_t or mongoc_client_pool_t object. That's it. That's the whole vibe. 🎀

🌸 PARAMETERS 🌸

  • params — a mongoc_oidc_callback_params_t. that's the one and only thing you're handing it, bestie 🫶

⭐ RETURNS ⭐

A string — which must not be modified or freed — or NULL.

⚠️ read that again, fr fr: do NOT modify it, do NOT free it. it's not yours to keep, it's on loan. <red>you will absolutely crash something if you free it</red> 💀

🦋 LIFECYCLE 🦋

okay this part is the main character of the caveats: the string is only valid for the duration of the invocation of the OIDC callback function. So use it inside the callback, then let it go. Not outside, not later, not "just one more line I promise". 🧚✨

👑 SEE ALSO 👑

  • mongoc_oidc_callback_params_t
  • mongoc_oidc_callback_t
  • mongoc_uri_t

like, go read those next, you'll get the whole picture 💖

🍓 AUTHOR 🍓

MongoDB, Inc

2009-present, MongoDB, Inc.

and that's the tea 🎀 this little gem is from libmongoc version 2.5.6, dated Oct 09 — love that for us. now go forth and get that username, bestie 💅✨🫶

📦 where this page comes from