libxconv/README.md

28 lines
872 B
Markdown
Raw Permalink Normal View History

2017-03-09 11:30:15 +00:00
# libxconv
Lightweight ISO-6937 to UTF-8 conversion library.
2017-03-10 09:00:34 +00:00
##### SYNOPSIS
2017-03-09 20:44:08 +00:00
> size\_t xconv(char \*inbuf, char \*outbuf, size\_t outbuflen);
2017-03-09 20:34:12 +00:00
2017-03-10 09:00:34 +00:00
##### DESCRIPTION
2017-03-09 20:34:12 +00:00
2017-03-09 20:39:56 +00:00
> The xconv() function converts a sequence of characters in ISO-6937
> encoding to UTF-8.
>
> If a UTF-8 sequence is found within the input string, processing is aborted.
2017-03-09 20:34:12 +00:00
2017-03-10 09:00:34 +00:00
##### RETURN VALUE
2017-03-09 20:34:12 +00:00
2017-03-09 20:39:56 +00:00
> On successful conversion, the xconv() function returns the number of
> characters placed into _outbuf_ excluding the string terminator.
>
> If no conversion is necessary (plain ASCII input string or a UTF-8 sequence
> was found) then the function returns 0. In this case, the state of the
2017-03-09 20:40:35 +00:00
> output buffer is undefined and it should not be used.
2017-03-09 20:34:12 +00:00
2017-03-10 09:00:34 +00:00
##### NOTES
2017-03-09 20:34:12 +00:00
2017-03-09 20:39:56 +00:00
> This library was written to replace iconv() for a specific conversion task
> in a small embedded environment with little memory or CPU time available.
2017-03-09 20:34:12 +00:00