gitweb.dragonflybsd.org Git - dragonfly.git/blame_incremental

... / ...

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