hal_pin_alias(3hal)

💖 NAME 💖

okay so bestie, you're reading the hal_pin_alias(3hal) manual page and I'm gonna walk you through it like we're texting at 2am 🫶

hal_pin_alias — creates an alternate name for a pin. that's the whole vibe. no cap. ✨

✨ SYNTAX ✨

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

literally copy that exactly, bestie. character for character. 💅

🎀 ARGUMENTS 🎀

• original_name — the original name of the pin. like its government name, the one it was born with. 👑
• alias — the alternate name that may be used to refer to the pin, or NULL to remove any alternate name. yes, NULL means "okay bestie, take the nickname back, we're done here" 💀

🌸 DESCRIPTION 🌸

so here's the tea: a pin may have two names. the original name — the one that was passed to a hal_pin_new function — and an alias. two names, one pin. main character energy fr fr. 👑

usually, aliases are for the convenience of users and should be created and destroyed via halcmd. that's the normal route, the group chat approved route. 🫶

however, in some cases it is sensible to create aliases directly in a component. when, you ask? these cases include the case where a pin is renamed, to preserve compatibility with old versions. so if you're rebranding a pin but still wanna be cool with the old era, this is your girl. 💅

🔥 RETURN VALUE 🔥

Returns a HAL status code. that's it. that's the whole return. short and iconic. periodt. 💅

🌈 SEE ALSO 🌈

• hal_param_alias(3) — go read that one too, bestie, it's giving sibling energy 🦋

mwah okay that's the whole page. this was the LinuxCNC Documentation version, dated 2006-10-12, and the manual name is hal_pin_alias(3hal). love u, stay slaying, and remember: aliases are temporary, but good documentation is forever. 💖✨🎀🦋🌸💅🫶