1.\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" Portions of this text are reprinted and reproduced in electronic form 26.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- 27.\" Portable Operating System Interface (POSIX), The Open Group Base 28.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of 29.\" Electrical and Electronics Engineers, Inc and The Open Group. In the 30.\" event of any discrepancy between this version and the original IEEE and 31.\" The Open Group Standard, the original IEEE and The Open Group Standard is 32.\" the referee document. The original Standard can be obtained online at 33.\" http://www.opengroup.org/unix/online.html. 34.\" 35.Dd February 23, 2023 36.Dt ICONVLIST 3 37.Os 38.Sh NAME 39.Nm iconvlist 40.Nd retrieving a list of character encodings supported by 41.Xr iconv 3 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In iconv.h 46.Ft void 47.Fo iconvlist 48.Fa "int \*[lp]*do_one\*[rp]\*[lp]unsigned int count, const char * const *names, void *arg\*[rp]" 49.Fa "void *arg" 50.Fc 51.Sh DESCRIPTION 52The 53.Fn iconvlist 54function obtains a list of character encodings that are supported by the 55.Xr iconv 3 56call. 57The 58.Fn do_one 59callback function will be called, where the 60.Fa count 61argument will be set to the number of the encoding names found, the 62.Fa names 63argument will be the list of the supported encoding names and the 64.Fa arg 65argument will be the \"outer\" 66.Fa arg 67argument of the 68.Fn iconvlist 69function. 70This argument can be used to interchange custom data between the caller of 71.Fn iconvlist 72and the callback function. 73.Pp 74If an error occurs, 75.Fa names 76will be NULL when calling 77.Fn do_one . 78.Sh SEE ALSO 79.Xr __iconv_free_list 3 , 80.Xr __iconv_get_list 3 , 81.Xr iconv 3 82.Sh STANDARDS 83The 84.Nm 85function is a non-standard extension, which appeared in 86the GNU implementation and was adopted in 87.Fx 9.0 88for compatibility's sake. 89.Sh AUTHORS 90This manual page was written by 91.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org . 92