TT_MESSAGE_CONTEXT_VAL(3)

πŸ“¦
version 2.5.3 Β· 2 versions
, in nixos 26.05

πŸ’– NAME πŸ’–

tt_message_context_val(library call) β€” okay bestie, that's the title/manual-name moment, and this function is here to retrieve the character string of a message's context. It's giving context-string retrieval energy, no cap. πŸ’…

✨ SYNOPSIS ✨

#include &<Tt/tt_c.h>
char *tt_message_context_val(
Tt_message m,
const char *slotname);

πŸŽ€ DESCRIPTION πŸŽ€

The tt_message_context_val function retrieves the character string of a message's context. Periodt. πŸŽ€

The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message.

If there is no context slot associated with slotname, tt_message_context_val returns a NULL pointer. That's the vibe check: no slot, NULL, done. πŸ™ˆ

πŸ”₯ RETURN VALUE πŸ”₯

Upon successful completion, the tt_message_context_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. 😭
  • TT_ERR_POINTER β€” The pointer passed does not point to an object of the correct type for this operation. πŸ’€
  • TT_ERR_SLOTNAME β€” The specified slotname is syntactically invalid. 🚩

🫢 APPLICATION USAGE 🫢

The application should use tt_free(3) to free any data stored in the address returned by the ToolTalk API. That's the cleanup bestie behavior: free it, don't leave it lying around. 🫢

🌈 SEE ALSO 🌈


πŸ’œ footer source/version sign-off: tt_message_context_val(library call); footer date: not listed on this page, so we're not inventing one, bestie β€” that's the cute sign-off. periodt. πŸ’œ

πŸ“¦ where this page comes from