← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/gFileDelete.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/gFileDelete.Rd
 
1
\alias{gFileDelete}
 
2
\name{gFileDelete}
 
3
\title{gFileDelete}
 
4
\description{Deletes a file. If the \code{file} is a directory, it will only be deleted if it 
 
5
is empty.}
 
6
\usage{gFileDelete(object, cancellable = NULL, .errwarn = TRUE)}
 
7
\arguments{
 
8
\item{\verb{object}}{input \code{\link{GFile}}.}
 
9
\item{\verb{cancellable}}{optional \code{\link{GCancellable}} object, \code{NULL} to ignore.}
 
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
\value{
 
16
A list containing the following elements:
 
17
\item{retval}{[logical] \code{TRUE} if the file was deleted. \code{FALSE} otherwise.}
 
18
\item{\verb{error}}{a \code{\link{GError}}, or \code{NULL} }
 
19
}
 
20
\author{Derived by RGtkGen from GTK+ documentation}
 
21
\keyword{internal}