Return to iconv_open_into.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libiconv / man

Annotation of embedaddon/libiconv/man/iconv_open_into.3, revision 1.1.1.2

1.1.1.2 ! misho       1: .\" Copyright (c) Free Software Foundation, Inc.
1.1       misho       2: .\"
                      3: .\" This is free documentation; you can redistribute it and/or
                      4: .\" modify it under the terms of the GNU General Public License as
                      5: .\" published by the Free Software Foundation; either version 3 of
                      6: .\" the License, or (at your option) any later version.
                      7: .\"
                      8: .\" References consulted:
                      9: .\"   iconv.h
                     10: .\"
                     11: .TH ICONV_OPEN_INTO 3  "September 21, 2008" "GNU" "Linux Programmer's Manual"
                     12: .SH NAME
                     13: iconv_open_into \- initialize descriptor for character set conversion
                     14: .SH SYNOPSIS
                     15: .nf
                     16: .B #include <iconv.h>
                     17: .sp
                     18: .BI "int iconv_open_into (const char* " tocode ", const char* " fromcode ","
                     19: .BI "                     iconv_allocation_t* " resultp );
                     20: .fi
                     21: .SH DESCRIPTION
                     22: The \fBiconv_open_into\fP function initializes a conversion descriptor suitable
                     23: for converting byte sequences from character encoding \fIfromcode\fP to
                     24: character encoding \fItocode\fP.  The conversion descriptor is stored in the
                     25: memory pointed to by \fIresultp\fP.
                     26: .PP
                     27: The values permitted for \fIfromcode\fP and \fItocode\fP are the same as for
                     28: the function \fBiconv_open\fP.
                     29: .PP
                     30: After a successful return from this function, \fIresultp\fP can be be used
                     31: as an \fBiconv_t\fP object with the \fBiconv\fP function.
                     32: .SH "RETURN VALUE"
                     33: The \fBiconv_open_into\fP function fills \fB*\fP\fIresultp\fP and returns 0 if
                     34: it succeeds. In case of error, it sets \fBerrno\fP and returns \-1.
                     35: .SH ERRORS
                     36: The following error can occur, among others:
                     37: .TP
                     38: .B EINVAL
                     39: The conversion from \fIfromcode\fP to \fItocode\fP is not supported by the
                     40: implementation.
                     41: .SH "CONFORMING TO"
                     42: This function is implemented only in GNU libiconv and not in other \fBiconv\fP
                     43: implementations. It is not backed by a standard. You can test for its presence
                     44: through \fB(_LIBICONV_VERSION >= 0x010D)\fP.
                     45: .SH "SEE ALSO"
                     46: .BR iconv_open (3)
                     47: .BR iconv (3)