xref: /dflybsd-src/lib/libc/iconv/iconvlist.3 (revision dfffc1a84effb9f6f8dde4ad135ac7317f4c2ee9)
10d5acd74SJohn Marino.\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
20d5acd74SJohn Marino.\" All rights reserved.
30d5acd74SJohn Marino.\"
40d5acd74SJohn Marino.\" Redistribution and use in source and binary forms, with or without
50d5acd74SJohn Marino.\" modification, are permitted provided that the following conditions
60d5acd74SJohn Marino.\" are met:
70d5acd74SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
80d5acd74SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
90d5acd74SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
100d5acd74SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
110d5acd74SJohn Marino.\"    documentation and/or other materials provided with the distribution.
120d5acd74SJohn Marino.\"
130d5acd74SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
140d5acd74SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
150d5acd74SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
160d5acd74SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
170d5acd74SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
180d5acd74SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
190d5acd74SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
200d5acd74SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
210d5acd74SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
220d5acd74SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
230d5acd74SJohn Marino.\" SUCH DAMAGE.
240d5acd74SJohn Marino.\"
250d5acd74SJohn Marino.\" Portions of this text are reprinted and reproduced in electronic form
260d5acd74SJohn Marino.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
270d5acd74SJohn Marino.\" Portable Operating System Interface (POSIX), The Open Group Base
280d5acd74SJohn Marino.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
290d5acd74SJohn Marino.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
300d5acd74SJohn Marino.\" event of any discrepancy between this version and the original IEEE and
310d5acd74SJohn Marino.\" The Open Group Standard, the original IEEE and The Open Group Standard is
320d5acd74SJohn Marino.\" the referee document.  The original Standard can be obtained online at
330d5acd74SJohn Marino.\"	http://www.opengroup.org/unix/online.html.
340d5acd74SJohn Marino.\"
350d5acd74SJohn Marino.\" $FreeBSD: head/lib/libc/iconv/iconvlist.3 233625 2012-03-28 19:20:28Z joel $
360d5acd74SJohn Marino.\"
37*dfffc1a8SSascha Wildner.Dd December 23, 2018
380d5acd74SJohn Marino.Dt ICONVLIST 3
390d5acd74SJohn Marino.Os
400d5acd74SJohn Marino.Sh NAME
410d5acd74SJohn Marino.Nm iconvlist
420d5acd74SJohn Marino.Nd retrieving a list of character encodings supported by
430d5acd74SJohn Marino.Xr iconv 3
440d5acd74SJohn Marino.Sh LIBRARY
450d5acd74SJohn Marino.Lb libc
460d5acd74SJohn Marino.Sh SYNOPSIS
470d5acd74SJohn Marino.In iconv.h
480d5acd74SJohn Marino.Ft void
490d5acd74SJohn Marino.Fo iconvlist
50*dfffc1a8SSascha Wildner.Fa "int (*do_one)(unsigned int count, const char * const *names, void *arg)"
510d5acd74SJohn Marino.Fa "void *arg"
520d5acd74SJohn Marino.Fc
530d5acd74SJohn Marino.Sh DESCRIPTION
540d5acd74SJohn MarinoThe
550d5acd74SJohn Marino.Fn iconvlist
560d5acd74SJohn Marinofunction obtains a list of character encodings that are supported by the
570d5acd74SJohn Marino.Xr iconv 3
580d5acd74SJohn Marinocall.
590d5acd74SJohn MarinoThe
600d5acd74SJohn Marino.Fn do_one
610d5acd74SJohn Marinocallback function will be called, where the
620d5acd74SJohn Marino.Fa count
630d5acd74SJohn Marinoargument will be set to the number of the encoding names found, the
640d5acd74SJohn Marino.Fa names
650d5acd74SJohn Marinoargument will be the list of the supported encoding names and the
660d5acd74SJohn Marino.Fa arg
670d5acd74SJohn Marinoargument will be the \"outer\"
680d5acd74SJohn Marino.Fa arg
690d5acd74SJohn Marinoargument of the
700d5acd74SJohn Marino.Fn iconvlist
710d5acd74SJohn Marinofunction.
720d5acd74SJohn MarinoThis argument can be used to interchange custom data between the caller of
730d5acd74SJohn Marino.Fn iconvlist
740d5acd74SJohn Marinoand the callback function.
750d5acd74SJohn Marino.Pp
760d5acd74SJohn MarinoIf an error occurs,
770d5acd74SJohn Marino.Fa names
780d5acd74SJohn Marinowill be NULL when calling
790d5acd74SJohn Marino.Fn do_one .
800d5acd74SJohn Marino.Sh SEE ALSO
810d5acd74SJohn Marino.Xr iconv 3 ,
82ed768960SSascha Wildner.Xr __iconv_free_list 3 ,
83ed768960SSascha Wildner.Xr __iconv_get_list 3
840d5acd74SJohn Marino.Sh STANDARDS
850d5acd74SJohn MarinoThe
860d5acd74SJohn Marino.Nm
870d5acd74SJohn Marinofunction is a non-standard extension, which appeared in
880d5acd74SJohn Marinothe GNU implementation and was adopted in
89d118ff3cSFranco Fichtner.Fx 9.0
900d5acd74SJohn Marinofor compatibility's sake.
910d5acd74SJohn Marino.Sh AUTHORS
920d5acd74SJohn MarinoThis manual page was written by
93d118ff3cSFranco Fichtner.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org .
94