hal_param_alias(3hal)

💖 NAME 💖

hal_param_alias — bestie, this is the one that gives a param a lil' second name ✨

It lives in the 3hal section of the HAL manual, and it's literally just here to hand out nicknames 🎀

✨ SYNTAX ✨

int hal_param_alias(const char *original_name, const char *alias);

That's it. Two strings, one int, no drama 💅

🫶 ARGUMENTS 🫶

• original_name — the actual, government-name of the param. The original one. The one it was born with 🍼
• alias — the alternate name that you're allowed to call the param by instead. OR, plot twist: pass NULL here and you remove whatever alternate name it had. Poof. Gone. No alias era 🙈

🌸 DESCRIPTION 🌸

Okay so here's the tea, bestie: a param can have two names. The original name — which is the one that got passed into a hal_param_new function — and then an alias on top of that. Two names, one param, main character energy fr fr 👑

Most of the time? Aliases are just there for the convenience of the users, and honestly they should be created and destroyed via halcmd. That's the normie way and it slays 🎀

BUT. In some cases it's genuinely sensible to create aliases directly inside a component, and those cases include the situation where a param gets renamed — because you wanna preserve compatibility with the old versions. Like, the old name still has to work, y'know? Nostalgia, but make it functional 💖

🔥 RETURN VALUE 🔥

It returns a HAL status code. That's the whole vibe check. Go read it, don't guess it ✨

👑 SEE ALSO 👑

• hal_pin_alias(3)

Written down by the LinuxCNC Documentation girlies, dated 2006-10-12, and filed under hal_param_alias(3hal) 💅✨

Later bestie, go alias something responsibly 🦋💜