.\" 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_gets" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mconv_gets \- Read a line using a code converter. 


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


.SH DESCRIPTION
Read a line using a code converter. 
.PP
The
.ft B
mconv_gets()
.ft R
function reads one line from the buffer area or the stream that is currently bound to code converter
.ft B
converter\fP.
.ft R
The decoder of
.ft B
converter
.ft R
is used for decoding. The decoded character sequence is appended at the end of M\-text
.ft B
mt\fP.
.ft R
The final newline character in the original byte sequence is not appended. The internal status of
.ft B
converter
.ft R
is updated appropriately.
.PP
.SH RETURN VALUE
.PP
.RS 4
If the operation was successful,
.ft B
mconv_gets()
.ft R
returns the modified
.ft B
mt\fP.
.ft R
If it encounters EOF without reading a single character, it returns
.ft B
mt
.ft R
without changing it. If an error is detected, it returns
.ft C
NULL
.ft R
and assigns an error code to
.ft B
merror_code\fP.
.ft R
.RE
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_CODING
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmconv_getc()\fP,
.ft R
.ft B
mconv_ungetc()\fP,
.ft R
.ft B
mconv_putc()
.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>.
