REMCTL_ERROR(3)

📦
version 3.18 · 3 versions
, in debian bookworm, debian trixie, epel 9, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 remctl_error — bestie, let's get that error message 💖

okay so this is the manual page for remctl_error from the remctl Library Reference, and honestly? it's a tiny little function with big main character energy. let's get into it 🫶

✨ NAME ✨

remctl_error — Retrieve the error from a failed remctl operation

like, the vibe is: something went wrong in remctl and you wanna know what. this is how you find out. 💅

🌸 SYNOPSIS 🌸

#include <remctl.h>

const char *remctl_error(struct remctl *r);

that's it. one include, one function, one argument. slay.

🦋 DESCRIPTION 🦋

so remctl_error() returns the error from a remctl operation that failed earlier. that's the whole job. it ate and left no crumbs. ✨

its only argument is a remctl struct, and you get that from remctl_new(). if the previous remctl operation actually went fine and succeeded, then it just returns the constant string "No error". yes queen, "No error", that's literally the exact string. 🌈

💀 okay so this part matters a LOT, bestie: the caller may not modify the returned string. like, not even a little. that string might literally live in read-only memory, and if you try to modify it you may cause a memory fault. do not touch. do not edit. hands off. 🫣

also, the returned pointer gets invalidated by the next call to any remctl API function with the same client object — and the only exception is another call to remctl_error() itself. so if you need that string, use it before you go calling other stuff on the same object, okay? iykyk. 🎀

⭐ RETURN VALUE ⭐

remctl_error() returns either the previous error, or the constant string "No error".

and the best part: it will never return NULL. never ever. no cap. 🔥 so you can always trust that pointer to point at something real.

🧚 COMPATIBILITY 🧚

this interface has been provided by the remctl client library since its initial release in version 2.0. so it's been here since day one, iconic behavior honestly. 👑

💜 AUTHOR 💜

Russ Allbery <eagle@eyrie.org>

Copyright 2007, 2009, 2014 The Board of Trustees of the Leland Stanford Junior University

copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. this file is offered as-is, without any warranty. (fr fr, as-is, no promises. 🙈)

SPDX-License-Identifier: FSFAP

🌟 SEE ALSO 🌟

the current version of the remctl library and complete details of the remctl protocol are available from its web page at <https://www.eyrie.org/~eagle/software/remctl/>. go look, bestie, it's giving documentation. 💖

okay and that's the whole page!! this was version 3.18, dated 2022-05-09, from the remctl Library Reference. mwah, ily, go catch those errors. 💅✨

📦 where this page comes from