From 2b6179194183abd250f9f0f3757c9b6b986feece Mon Sep 17 00:00:00 2001
From: Bruno Haible <bruno@clisp.org>
Date: Sat, 11 Apr 2009 02:46:54 +0200
Subject: Document the 'enum iconv_ilseq_handler'.

---
 doc/uniconv.texi | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'doc')

diff --git a/doc/uniconv.texi b/doc/uniconv.texi
index 08197c5..e10db67 100644
--- a/doc/uniconv.texi
+++ b/doc/uniconv.texi
@@ -21,6 +21,27 @@ around the native @code{iconv_open} function.  It may not work as an argument
 to the native @code{iconv_open} function directly.
 @end deftypefun
 
+The handling of unconvertible characters during thre conversions can be
+parametrized through the following enumeration type:
+
+@deftp Type {enum iconv_ilseq_handler}
+This type specifies how unconvertible characters in the input are handled.
+@end deftp
+
+@deftypevr Constant {enum iconv_ilseq_handler} iconveh_error
+This handler causes the function to return with @code{errno} set to
+@code{EILSEQ}.
+@end deftypevr
+
+@deftypevr Constant {enum iconv_ilseq_handler} iconveh_question_mark
+This handler produces one question mark @samp{?} per unconvertible character.
+@end deftypevr
+
+@deftypevr Constant {enum iconv_ilseq_handler} iconveh_escape_sequence
+This handler produces an escape sequence @code{\u@var{xxxx}} or
+@code{\U@var{xxxxxxxx}} for each unconvertible character.
+@end deftypevr
+
 @cindex converting
 The following functions convert between strings in a specified encoding and
 Unicode strings.
-- 
cgit v1.2.1