mconv_encode_buffer(3m17n)

📦
version 1.8.4 · 2 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 mconv_encode_buffer — from the m17n library, bestie 💖

okay so. you found your way into the 3m17n manual pages and honestly? iconic. this one's about turning your fancy M-text into plain old bytes, and it is not as scary as it sounds. let's get into it. 🦋

✨ SYNOPSIS ✨

int mconv_encode_buffer (MSymbol name, MText * mt, unsigned char * buf,
int n)

like, five things go in, one int comes out. that's the whole vibe. 💅

🌸 DESCRIPTION 🌸

So. mconv_encode_buffer() is the girl who takes your M-text and encodes it into a buffer area. that's literally her whole job.

Here's the tea: she takes the M-text mt, encodes it based on the coding system called name, and writes the resulting byte sequence into the buffer area that buf is pointing at. 📝

how much does she write? at most n bytes. that's the cap, bestie, no going over. 🙅

and the cutest part? a temporary code converter for encoding gets automatically created and then freed. you don't have to do a thing. she handles it. main character energy fr fr. ✨

🎀 RETURN VALUE 🎀

okay so this is the part you actually need to remember:

  • if everything went good? she returns the number of written bytes. slay. 💚
  • if it did not go good? she returns -1, and she assigns an error code to the external variable merror_code. 😭

that's it. that's the whole report card.

💀 ERRORS 💀

the two possible error codes you might catch in merror_code:

  • MERROR_IO
  • MERROR_CODING
ngl if you see one of these, something in your coding system situation is not giving what it's supposed to give. 🙈

🔥 SEE ALSO 🔥

go read these next, they're in the same friend group:

  • mconv_encode()
  • mconv_encode_stream()

Copyright (C) 2001 Information-technology Promotion Agency (IPA)

Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.

and that's the page, bestie!! 🫶 this was Version 1.8.4, dated Mon Sep 25 2023, from the m17n manual. go forth and encode responsibly. periodt. 💖✨🎀🦋🌸

📦 where this page comes from