← Back to branch summary

~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/gDataInputStreamReadLine.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/gDataInputStreamReadLine.Rd
 
1
\alias{gDataInputStreamReadLine}
 
2
\name{gDataInputStreamReadLine}
 
3
\title{gDataInputStreamReadLine}
 
4
\description{Reads a line from the data input stream.}
 
5
\usage{gDataInputStreamReadLine(object, cancellable = NULL, .errwarn = TRUE)}
 
6
\arguments{
 
7
\item{\verb{object}}{a given \code{\link{GDataInputStream}}.}
 
8
\item{\verb{cancellable}}{optional \code{\link{GCancellable}} object, \code{NULL} to ignore.}
 
9
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
10
}
 
11
\details{If \code{cancellable} is not \code{NULL}, then the operation can be cancelled by
 
12
triggering the cancellable object from another thread. If the operation
 
13
was cancelled, the error \code{G_IO_ERROR_CANCELLED} will be returned.}
 
14
\value{
 
15
A list containing the following elements:
 
16
\item{retval}{[char]  a string with the line that was read in (without the newlines).
 
17
    Set \code{length} to a \verb{numeric} to get the length of the read line.
 
18
    On an error, it will return \code{NULL} and \code{error} will be set. If there's no
 
19
    content to read, it will still return \code{NULL}, but \code{error} won't be set.}
 
20
\item{\verb{length}}{a \verb{numeric} to get the length of the data read in.}
 
21
\item{\verb{error}}{\code{\link{GError}} for error reporting.}
 
22
}
 
23
\author{Derived by RGtkGen from GTK+ documentation}
 
24
\keyword{internal}