cl_hp_parse_field(3)

💅 cl_hp_parse_field — the libcanlock-hp one, from the canlock-hp 3.3.2 manual ✨

okay bestie, sit down, we're doing the cl_hp_parse_field(3) page and honestly it's giving "small but mighty" 🎀

---

🌸 NAME 🌸

cl_hp_parse_field — this one literally just runs the field parser for you, no cap 🫶

---

✨ SYNOPSIS ✨

#include <libcanlock-3/canlock-hp.h>

char *cl_hp_parse_field(const char *data, size_t data_len);

look at her. two params. flawless. 👑

---

💖 DESCRIPTION 💖

so the way that cl_hp_parse_field() works is: it executes the header field parser. that's the whole vibe fr fr.

and here's the tea — this implementation runs the canlock-hfp utility in a separate process. like, she outsources. iconic behaviour honestly 💅

• data — this parameter should point to the beginning of the input data. right at the start, bestie, no skipping ahead 🦋
• data_len — and you specify the length of the input data here. that's it, that's the param ✨

now the important bit, pay attention 👀 the input data must be an unfolded "Cancel-Lock" or "Cancel-Key" header field, without a line break at the end. like, unfolded. no trailing newline. that's the rule and we respect it 🙏

and if your data isn't already in that state, the lib's got your back:

• cl_hp_get_field() — use this to extract a field from the message header 🎀
• cl_hp_unfold_field() — use this to remove potential folding from an already extracted header field 🌈

chain them together, it's a whole little pipeline, she ate 💅

---

🔥 RETURN VALUE 🔥

if the parser reports success, you get a pointer to the NUL-terminated output data. success = pointer, we love that for you 💜

otherwise? NULL. that's it. no in-between. it's giving binary. 💀

⚠️ okay important warning bestie: on success, the caller is responsible to free() the memory block allocated for the output data. the memory is yours now. don't ghost it. free it. fr fr 😭

---

👑 AUTHORS 👑

Michael Baeuerle — the main character who wrote this 🫶

---

🙈 REPORTING BUGS 🙈

found a bug? report it to <mailto:michael.baeuerle@gmx.net>. don't be shy, they want to know 🌸

---

🧚 STANDARDS 🧚

cl_hp_parse_field() tries to comply with the following standards:

• RFC 8315 📜

(tries to. we love an honest queen 💅)

---

⭐ SEE ALSO ⭐

• free(3) — you WILL need this one, remember the return value section 😭
• cl_hp_get_field(3)
• cl_hp_unfold_field(3)
• canlock-hfp(1) — the separate-process star of the show
• canlock-mhp(1)
• canlock(1)

go read them all, iykyk 🦋

---

and that's the page!! this cutie lives in the canlock-hp 3.3.2 manual, dated 2024-05-11 — mwah, go free your pointers, bestie 💖✨🎀