TT_MESSAGE_ARG_VAL(3)

📦
version 2.5.3 · 2 versions
, in nixos 26.05

✨ NAME ✨

okay so bestie, welcome to tt_message_arg_val — it's from the library call manual, and its whole job is to return a pointer to the value of a message argument. literally that's the name section, no cap 💅

🦋 SYNOPSIS 🦋

#include &<Tt/tt_c.h>
char *tt_message_arg_val(
Tt_message m,
int n);

🌸 DESCRIPTION 🌸

The tt_message_arg_val function returns a pointer to the value of the nth message argument.

The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be returned. The first argument is numbered zero. zero, bestie — not one, zero 🫶

🌀 RETURN VALUE 🌀

Upon successful completion, the tt_message_arg_val function returns the contents for the message argument. The application can use tt_ptr_error(3) to extract one of the following Tt_status values from the returned pointer:

  • TT_OK — the operation completed successfully. slay ✨
  • TT_ERR_NOMP — the ttsession(1) process is not running and the ToolTalk service cannot restart it. oof, that's a whole vibe emergency 😭
  • TT_ERR_NUM — the integer value passed was invalid (out of range). number said no 🙈
  • TT_ERR_POINTER — the pointer passed does not point to an object of the correct type for this operation. wrong-type energy, not iconic 💀

🎀 APPLICATION USAGE 🎀

The application can use tt_free(3) to free any data stored in the address returned by the ToolTalk API. clean up after yourself, bestie 🧚

🔥 SEE ALSO 🔥

Tt/tt_c.h - Tttt_c(5), tt_ptr_error(3), tt_free(3).

cute sign-off: the footer/source line is tt_message_arg_val(library call) and there's no date listed on this page — so that's the vibe, mwah 💅🎀

📦 where this page comes from