NET_FreeLocalAddresses(3)

📦
version 3.2.0 · 2 versions
, in fedora 43, fedora 44

💖 NET_FreeLocalAddresses(3) 💖

okay bestie, welcome to the SDL_net3 section of the manual — yes that's the manual name, we're in the SDL_net3 FUNCTIONS zone, stay with me 🫶

✨ NAME ✨

NET_FreeLocalAddresses — the lil cleanup crew that frees the results you got from NET_GetLocalAddresses.

🌸 SYNOPSIS 🌸

#include <SDL3_net/SDL_net.h>

void NET_FreeLocalAddresses(NET_Address **addresses);

🎀 DESCRIPTION 🎀

so basically, this function unrefs every address in the array and then frees the array itself. two-for-one. ate. 💅

here's the cute part: addresses are reference counted, so it is totally safe to keep any addresses you want from this array even after you call this function — as long as you called NET_RefAddress() on them first. like, grab your faves, ref them, then let the array go. no cap. ✨

and it is safe to pass a NULL in here — it will just be ignored. no drama, no crash, iconic behaviour honestly. 🦋

🧚 FUNCTION PARAMETERS 🧚

  • addresses — a pointer that was returned by NET_GetLocalAddresses(). yes, that exact one. don't be out here making up your own. 🙈

🔥 THREAD SAFETY 🔥

it is safe to call this function from any thread. literally any of them. go wild. 👑

💜 AVAILABILITY 💜

this function has been available since SDL_net 3.0.0. vintage but make it fresh. 🌈

not me ending the page without a single warning section because there isn't one 😭 the whole thing is just safe. we love a low-stress free function fr fr. 💖

kisses, this has been your girl from the SDL_net era — the docs are stamped SDL_net 3.2.0, so if your version is giving something older, that's a whole different vibe check. bye bestie, go free those addresses responsibly 🎀✨💅

📦 where this page comes from