.\"
.\" $Id: cxGets.3,v 1.1 2003/03/06 04:54:41 chipx86 Exp $
.\"
.\" Copyright (C) 2002-2003 The GNUpdate Project.
.\"
.\" This library is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU Library General Public
.\" License as published by the Free Software Foundation; either
.\" version 2 of the License, or (at your option) any later version.
.\"
.\" This library is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" Library General Public License for more details.
.\"
.\" You should have received a copy of the GNU Library General Public
.\" License along with this library; if not, write to the
.\" Free Software Foundation, Inc., 59 Temple Place - Suite 330,
.\" Boston, MA  02111-1307, USA.
.\"
.TH "cxGets" 3 "05 Mar 2003" "libcomprex" "The GNUpdate Project"
.SH "NAME"
cxGets \- Reads in a line from from a file pointer.
.SH "SYNOPSIS"
.ft B
#include <comprex.h>

char *cxGets(char *buffer, size_t size, CxFP *fp);
.ft R
.SH "PARAMETERS"
.TP
.B "buffer"
The buffer to store the line in.
.TP
.B "size"
The maximum number of bytes to read it. Also the size of the buffer.
.TP
.B "fp"
The file pointer.
.SH "DESCRIPTION"
Reads in a line from from a file pointer.

No more than \fIsize\fR - 1 bytes will be read in. If a newline is encountered, it is stored and no further data will be read in. The resulting buffer is NUL-terminated.
.SH "RETURNS"
Nothing.