libxconv/README.md

28 lines
828 B
Markdown
Raw Normal View History

2017-03-09 11:30:15 +00:00
# libxconv
Lightweight ISO-6937 to UTF-8 conversion library.
2017-03-09 20:34:12 +00:00
## SYNOPSIS
2017-03-09 20:38:52 +00:00
int xconv(char \*inbuf, char \*outbuf, size\_t outbuflen);
2017-03-09 20:34:12 +00:00
## DESCRIPTION
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.
## RETURN VALUE
On successful conversion, the xconv() function returns the number of
2017-03-09 20:38:52 +00:00
characters placed into _outbuf_ excluding the string terminator.
2017-03-09 20:34:12 +00:00
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
output buff is undefined and it should not be used.
## NOTES
This library was written to replace iconv() for a specific conversion task
in a small embedded environment with little memory or CPU time available.