wyiconv.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2006
.\"
.TH WyIConv 3wy "libwy v0.31"
.SH NAME
WyIConv \- class for character set conversion
.SH SYNOPSIS
.B #include <wyiconv.h>
.PP
WyIConv is a class for conversion of (multi)byte sequences.
.SH "PUBLIC MEMBERS"
 class \fBReply\fP : public WyRet
 \fBWyIConv\fP() throw()
 \fBWyIConv\fP(const char*, const char*)
 \fB~WyIConv\fP()
 WyRet \fBreset\fP(void)
 WyRet \fBreset\fP(const char*, const char*)
 WyRet \fBiconv\fP(WyCSeg&, WyStr&, size_t&)
 WyRet \fBiconv\fP(void)
 WyRet \fBiconv\fP(WyStr&)
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "class Reply : public WyRet
.PP
    Class specific throw type
.\"--------------------------------------------
.PP
.BI "WyIConv() throw()"
.PP
    Construct default object
.\"--------------------------------------------
.PP
.BI "WyIConv(const char* " "tocode" ", const char* " "fromcode" ")"
.PP
    Construct object to convert (multi)byte sequence of encoding
    \fIfromcode\fP to encoding \fItocode\fP. The object is created in the
    initial conversion state.

    Note: See Linux utility "iconv --list" for known encodings
.PP
    [\fBThrow\fP] Reply
            Wym_EINVAL      The conversion from \fIfromcode\fP to \fItocode\fP
                            is not supported by the implementation
            ...
.PP 
    [\fBRefer\fP] ::iconv_open
.\"--------------------------------------------
.PP
.BI "~WyIConv()"
.PP
    Destruct *this
.PP
    [\fBRefer\fP] ::iconv_close
.\"--------------------------------------------
.PP
.BI "WyRet reset(void)" 
.PP
    Reconstruct *this to the state as WyIConv()
.PP
    [\fBRet\fP] Ok              Succeed
          ...             
.PP
    [\fBRefer\fP] ::iconv_close
.\"--------------------------------------------
.PP
.BI "WyRet reset(const char* " "tocode" ", const char* " "fromcode" ")"
.PP
    Reconstruct *this to the state as WyIConv(\fItocode\fP,\fIfromcode\fP)
.PP
    [\fBRet\fP] Ok              Succeed
          Wym_EINVAL      The conversion from \fIfromcode\fP to \fItocode\fP
                          is not supported by the implementation
          ...
.PP
    [\fBRefer\fP] ::iconv_open
.\"--------------------------------------------
.PP
.BI "WyRet iconv(WyCSeg& " "input" ", WyStr& " "outbuf" ", size_t& " "n_rev" ")"
.PP
    Convert the (multi)byte sequence pointed by \fIinput\fP, from current
    encoding and conversion state, to the target (multi)byte
    encoding and store into \fIoutbuf\fP

    When returned, \fIinput\fP is reset to the range of input
    (multi)byte sequence not yet converted. \fIn_rev\fP is reset with
    the number of characters converted in a non-reversible way.
.PP
    [\fBRet\fP] Ok              Succeed
          Wym_EILSEQ      Invalid (multi)byte sequence encountered
          Wym_EINVAL      Incomplele (multi)byte sequence encountered
          Wym_ELOOP       \fIinput\fP and \fIoutbuf\fP overlap
          Wym_EFBIG       \fIoutbuf\fP size would exceed the maximum
          Wym_ENOMEM      Not enough memory
.PP
    [\fBRefer\fP] ::iconv
.\"--------------------------------------------
.PP
.BI "WyRet iconv(void)" 
.PP
    Set the conversion to initial conversion state
.PP
    [\fBRet\fP] Ok              Succeed
          Wym_ENOMEM      Not enough memory
          ...             
.PP
    [\fBRefer\fP] ::iconv
.\"--------------------------------------------
.PP
.BI "WyRet iconv(WyStr& " "seq" ")"
.PP
    Set the conversion to initial conversion state and reset \fIseq\fP
    with the corresponding shift sequence
.PP
    [\fBRet\fP] Ok              Succeed
          Wym_ENOMEM      Not enough memory
          ...             
.PP
    [\fBRefer\fP] ::iconv
.\"--------------------------------------------
.SH "SEE ALSO"
.BR wystr
.BR wycseg
.BR wyregfile
.BR wytimespec
.BR wy_thread
.SH NOTE
Except added by this library, replys are converted from the errno 
an underlying C library function returned. Report of such replys
are brief from Linux Programmer's Manual. See the associated man page
for details.

Project is in development, http://sourceforge.net/projects/libwx