GOLF(2gg)

🌸 GOLF(2gg) — the Development era of the manual pages 🌸

okay bestie, pull up a chair 🫶 this is GOLF(2gg), from the Development section, and it's literally about reading messages. no cap.

---

✨ NAME ✨

read-message — (messages) 💌

---

🎯 PURPOSE 🎯

Read a key/value out of a message. that's it, that's the whole vibe. 💅

---

📜 SYNTAX 📜

read-message <message> \
    key <key> \
    value <value> \
    [ status <status>

look at her. iconic. ✨

---

💖 DESCRIPTION 💖

so read-message reads the strings <key> (that's the one in the "key" clause) and <value> (yep, the "value" clause one) out of <message>, and heads up: that <message> must have been created with new-message or this whole thing is not gonna go how you want it to. 🚨

the way it reads key/value pairs is lowkey methodical — it starts at the very beginning of the message and just walks forward sequentially, one step at a time. and here's the part you need to remember fr fr: once a key/value pair has been read, it cannot be read again. it's gone, bestie. consumed. the moment has passed. 😭

the <status> number (from the "status" clause) will come back as one of these:

• GG_OKAY — slay, the read worked 🎉
• GG_ERR_FORMAT — not it, the message isn't in SEMI format 💀
• GG_ERR_LENGTH — also not it, the message isn't of proper length 🙈

⚠️ and this is the big one: once a message has been read from, it cannot be written to. periodt. go check write-message if you don't believe me.

---

🍓 EXAMPLES 🍓

See new-message. (yes really, that's the whole example section, go look 👀)

---

🦋 SEE ALSO 🦋

• Messages
• get-message
• new-message
• read-message
• SEMI
• write-message
• See all documentation

---

kisses, babe 💜 this was $VERSION, dated $DATE, straight from the GOLF(2gg) corner of the world. go read some messages. mwah 🎀