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

« back to all changes in this revision

Viewing changes to man/gFileOpenReadwrite.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:
 
1
\alias{gFileOpenReadwrite}
 
2
\name{gFileOpenReadwrite}
 
3
\title{gFileOpenReadwrite}
 
4
\description{Opens an existing file for reading and writing. The result is
 
5
a \code{\link{GFileIOStream}} that can be used to read and write the contents of the file.}
 
6
\usage{gFileOpenReadwrite(object, cancellable = NULL, .errwarn = TRUE)}
 
7
\arguments{
 
8
\item{\verb{object}}{\code{\link{GFile}} to open}
 
9
\item{\verb{cancellable}}{a \code{\link{GCancellable}}}
 
10
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
11
}
 
12
\details{If \code{cancellable} is not \code{NULL}, then the operation can be cancelled by
 
13
triggering the cancellable object from another thread. If the operation
 
14
was cancelled, the error \code{G_IO_ERROR_CANCELLED} will be returned.
 
15
  
 
16
If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
 
17
If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
 
18
Other errors are possible too, and depend on what kind of filesystem the file is on.
 
19
Note that in many non-local file cases read and write streams are not supported,
 
20
so make sure you really need to do read and write streaming, rather than
 
21
just opening for reading or writing.
 
22
  Since 2.22}
 
23
\value{
 
24
A list containing the following elements:
 
25
\item{retval}{[\code{\link{GFileIOStream}}] \code{\link{GFileIOStream}} or \code{NULL} on error.}
 
26
\item{\verb{error}}{a \code{\link{GError}}, or \code{NULL}}
 
27
}
 
28
\author{Derived by RGtkGen from GTK+ documentation}
 
29
\keyword{internal}