.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2009
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mconv_decode" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mconv_decode \- Decode a byte sequence into an M\-text. 


.SH SYNOPSIS
\fBMText\fP*
\fBmconv_decode\fP (\fBMConverter\fP *
\fIconverter\fP, \fBMText\fP *
\fImt\fP)


.SH DESCRIPTION
Decode a byte sequence into an M\-text. 
.PP
The
.ft B
mconv_decode()
.ft R
function decodes a byte sequence and appends the result at the end of M\-text
.ft B
mt\fP.
.ft R
The source byte sequence is taken from either the buffer area or the stream that is currently bound to
.ft B
converter\fP.
.ft R
.PP
.SH RETURN VALUE
.PP
.RS 4
If the operation was successful,
.ft B
mconv_decode()
.ft R
returns updated
.ft B
mt\fP.
.ft R
Otherwise it returns
.ft C
NULL
.ft R
and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_IO\fP,
.ft R
.ft C
MERROR_CODING
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmconv_rebind_buffer()\fP,
.ft R
.ft B
mconv_rebind_stream()\fP,
.ft R
.ft B
mconv_encode()\fP,
.ft R
.ft B
mconv_encode_range()\fP,
.ft R
.ft B
mconv_decode_buffer()\fP,
.ft R
.ft B
mconv_decode_stream()
.ft R
.RE
.PP

.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2009 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.
