GET_STATUS(4)

💅 NAME 💅

okay so bestie, welcome to the Get_Status(special file) page — the manual name is special file, and Get_Status is here to retrieve a tool's current status. That's the whole name vibe. no cap. 💖

✨ SYNOPSIS ✨

here's the signature, copied exactly because we do not mess with function shapes:

       Get_Status(out string status,
               out string vendor,
               out string toolName,
               out string toolVersion
               [in messageID operation2Query]);

---

🦋 DESCRIPTION 🦋

The Get_Status request retrieves the current status of a tool — or, optionally, of a specific operation being performed by a tool. highkey useful.

• status — the status retrieved. yes, that's the whole vibe.
• vendor — the name of the vendor of the handling tool. slay.
• toolName — the name of the handling tool.
• toolVersion — the version of the handling tool.

🎀 OPTIONAL 🎀

• operation2Query — this is the ID of the request that initiated the operation the status of which is being requested. iykyk, it's the “which operation tho?” argument. 🫶

🌸 APPLICATION USAGE 🌸

The ttdt_session_join(3) and ttdt_message_accept(3) functions can be used to register for, and help process, the Get_Status request. so if you're building that handler life, those are the ones. ✨

🔥 EXAMPLES 🔥

After sending a TT_REQUEST and storing its handle in Tt_message request_I_sent, if the handler identifies itself with a Status notice saved in Tt_message status_msg_from_handler, then the status of request_I_sent can be queried as in the following example:

       Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
                       tt_message_sender(status_msg_from_handler),
                       TTDT_GET_STATUS, my_callback);
       tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
       tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
       tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
       tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
       tt_message_arg_add(msg, TT_IN, Tttk_string,
                               tt_message_id(request_I_sent));
       tt_message_send(msg);

👑 SEE ALSO 👑

• tt_message_arg_add(3)
• tt_message_id(3)
• tt_message_send(3)
• ttdt_message_accept(3)
• tt_message_sender(3)
• ttdt_session_join(3)

byeeee bestie 💖 footer/source-line vibe check: it's just Get_Status(special file) at the bottom — no extra source/version or date details beyond that, so that's the cute sign-off. mwah. 🌈