← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/gFileLoadContentsFinish.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/gFileLoadContentsFinish.Rd
 
1
\alias{gFileLoadContentsFinish}
 
2
\name{gFileLoadContentsFinish}
 
3
\title{gFileLoadContentsFinish}
 
4
\description{Finishes an asynchronous load of the \code{file}'s contents. 
 
5
The contents are placed in \code{contents}, and \code{length} is set to the 
 
6
size of the \code{contents} string. If \code{etag.out} is present, it will be 
 
7
set to the new entity tag for the \code{file}.}
 
8
\usage{gFileLoadContentsFinish(object, res, .errwarn = TRUE)}
 
9
\arguments{
 
10
\item{\verb{object}}{input \code{\link{GFile}}.}
 
11
\item{\verb{res}}{a \code{\link{GAsyncResult}}. }
 
12
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
13
}
 
14
\value{
 
15
A list containing the following elements:
 
16
\item{retval}{[logical] \code{TRUE} if the load was successful. If \code{FALSE} and \code{error} is 
 
17
present, it will be set appropriately. }
 
18
\item{\verb{contents}}{a location to place the contents of the file.}
 
19
\item{\verb{length}}{a location to place the length of the contents of the file,
 
20
    or \code{NULL} if the length is not needed}
 
21
\item{\verb{etag.out}}{a location to place the current entity tag for the file,
 
22
    or \code{NULL} if the entity tag is not needed}
 
23
\item{\verb{error}}{a \code{\link{GError}}, or \code{NULL}}
 
24
}
 
25
\author{Derived by RGtkGen from GTK+ documentation}
 
26
\keyword{internal}