TT_SESSION_PROPNAME(3)

📦
version 2.5.3 · 2 versions
, in nixos 26.05

💅 tt_session_propname 💅

okay so we're in the library call section, and this page is literally called tt_session_propname(library call) — bestie, it's giving "pull one property name out of a session" energy, and we're gonna make it make sense. no cap. ✨

🏷️ NAME

tt_session_propname — returns an element of the list of property names for a session. periodt. 💖

📜 SYNOPSIS

#include &<Tt/tt_c.h>
char *tt_session_propname(
const char *sessid,
int n);

🌸 DESCRIPTION

so tt_session_propname returns the nth element of the list of currently defined property names for the specified session. bestie, think of it as reaching into that session's property-name list and grabbing item number n. lowkey iconic. 🎀

the sessid argument is the name of the session joined. the application can use the sessid value returned when tt_default_session is called. the n argument is the number of the item in the property name list for which a name is to be obtained. the list numbering begins with zero — yes, zero is first, iykyk. ✨

🔥 RETURN VALUE

upon successful completion, tt_session_propname returns the name of the specified property from the session property list. if there are n properties or fewer, tt_session_propname returns NULL. 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_NUM — the integer value passed was invalid (out of range). 🚨
  • TT_ERR_SESSION — the specified ToolTalk session is out of date or invalid. 💀

🫶 APPLICATION USAGE

bestie, the application should use tt_free(3) to free any data stored in the address returned by the ToolTalk API. do not leave that pointer hanging, okay? that's the vibe check. 🧚

👀 SEE ALSO

byeee 🎀 — footer stamp: tt_session_propname(library call). that's the source/version flex at the very end, bestie; mwah 💋

📦 where this page comes from