TT_MESSAGE_ARG_BVAL_SET(3)

📦
version 2.5.3 · 2 versions
, in nixos 26.05

✨ NAME ✨

tt_message_arg_bval_set — set the byte-array value and type of a message argument

okay so this page is tt_message_arg_bval_set, and it lives in the (library call) manual, bestie. it's giving “tiny function, very specific job” energy and honestly? we love that for it 💅

🌸 SYNOPSIS 🌸

#include &<Tt/tt_c.h>
Tt_status tt_message_arg_bval_set(
Tt_message m,
int n,
const unsigned char *value,
int len);

💖 DESCRIPTION 💖

tt_message_arg_bval_set sets the byte-array value and the type of the *n*th message argument. iconic behavior, no cap ✨

This function also changes the value of an existing *n*th message argument to a byte string. so yes, it can rewrite an argument that already exists — very main character of it 🦋

Here's the cast of characters, because we stay organized:

  • m — the opaque handle for the message involved in this operation. it's literally the message's little ID badge 🎀
  • n — the number of the argument to set. The first argument is numbered zero. zero-indexed bestie, don't forget 😭
  • value — the byte string with the contents for the message argument. the actual data, periodt 💜
  • len — the length of value in bytes. yes, bytes — we're counting them fr fr 🫶

🔥 RETURN VALUE 🔥

Upon successful completion, the tt_message_arg_bval_set function returns the status of the operation as one of the following Tt_status values:

  • TT_OK — The operation completed successfully. slay ✅
  • TT_ERR_NOMP — The ttsession(1) process is not running and the ToolTalk service cannot restart it. not the ttsession erasure 😭
  • TT_ERR_NUM — The integer value passed was invalid (out of range). bestie, that number is not invited to the party 🚫
  • TT_ERR_POINTER — The pointer passed does not point to an object of the correct type for this operation. wrong vibe, wrong type, we can't use it 💀

🌈 APPLICATION USAGE 🌈

The sending process can use tt_message_arg_bval_set(3) to fill in opaque data. that's the whole little mission: sending process, opaque data, done and dusted 💫

🦋 SEE ALSO 🦋

source/version: the (library call) manual entry for tt_message_arg_bval_set; date: honestly not printed on this page, so no date reveal today 🙈 bye bestie, go set those byte-array args 💖✨

📦 where this page comes from