← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/gFileLoadContentsAsync.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/gFileLoadContentsAsync.Rd
 
1
\alias{gFileLoadContentsAsync}
 
2
\name{gFileLoadContentsAsync}
 
3
\title{gFileLoadContentsAsync}
 
4
\description{Starts an asynchronous load of the \code{file}'s contents.}
 
5
\usage{gFileLoadContentsAsync(object, cancellable = NULL, callback, user.data = NULL)}
 
6
\arguments{
 
7
\item{\verb{object}}{input \code{\link{GFile}}.}
 
8
\item{\verb{cancellable}}{optional \code{\link{GCancellable}} object, \code{NULL} to ignore.}
 
9
\item{\verb{callback}}{a \code{\link{GAsyncReadyCallback}} to call when the request is satisfied}
 
10
\item{\verb{user.data}}{the data to pass to callback function}
 
11
}
 
12
\details{For more details, see \code{\link{gFileLoadContents}} which is
 
13
the synchronous version of this call.
 
14
  
 
15
When the load operation has completed, \code{callback} will be called 
 
16
with \code{user} data. To finish the operation, call 
 
17
\code{\link{gFileLoadContentsFinish}} with the \code{\link{GAsyncResult}} returned by 
 
18
the \code{callback}.
 
19
  
 
20
If \code{cancellable} is not \code{NULL}, then the operation can be cancelled by
 
21
triggering the cancellable object from another thread. If the operation
 
22
was cancelled, the error \code{G_IO_ERROR_CANCELLED} will be returned.}
 
23
\author{Derived by RGtkGen from GTK+ documentation}
 
24
\keyword{internal}