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 October 20, 2009 36.Dt __ICONV_GET_LIST 3 37.Os 38.Sh NAME 39.Nm __iconv_get_list , 40.Nm __iconv_free_list 41.Nd retrieving a list of character encodings supported by 42.Xr iconv 3 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In iconv.h 47.Ft int 48.Fn __iconv_get_list "char ***names" "size_t count" "bool paired" 49.Ft void 50.Fn __iconv_free_list "char **names" "size_t count" 51.Sh DESCRIPTION 52The 53.Fn __iconv_get_list 54function obtains a list of character encodings that are supported by the 55.Xr iconv 3 56call. 57The list of the encoding names will be stored in 58.Fa names 59and the number of the entries is stored in 60.Fa count . 61If the 62.Fa paired 63variable is true, the list will be arranged into 64canonical/alias name pairs. 65.Pp 66The 67.Fn __iconv_free_list 68function is to free the allocated memory during the call of 69.Fn __iconv_get_list . 70.Sh RETURN VALUES 71Upon successful completion 72.Fn __iconv_get_list 73returns 0 and set the 74.Fa names 75and 76.Fa count 77arguments. 78Otherwise, \-1 is returned and errno is set to indicate the error. 79.Sh SEE ALSO 80.Xr iconv 3 , 81.Xr iconvlist 3 82.Sh STANDARDS 83The 84.Nm __iconv_get_list 85and 86.Nm __iconv_free_list 87functions are non-standard interfaces, which appeared in 88the implementation of the Citrus Project. 89The iconv implementation of the Citrus Project was adopted in 90.Fx 9.0 . 91.Sh AUTHORS 92This manual page was written by 93.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org . 94