← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/gSeekableSeek.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/gSeekableSeek.Rd
 
1
\alias{gSeekableSeek}
 
2
\name{gSeekableSeek}
 
3
\title{gSeekableSeek}
 
4
\description{Seeks in the stream by the given \code{offset}, modified by \code{type}.}
 
5
\usage{gSeekableSeek(object, offset, type = "G_SEEK_SET", cancellable = NULL, .errwarn = TRUE)}
 
6
\arguments{
 
7
\item{\verb{object}}{a \code{\link{GSeekable}}.}
 
8
\item{\verb{offset}}{a \verb{numeric}.}
 
9
\item{\verb{type}}{a \code{\link{GSeekType}}.}
 
10
\item{\verb{cancellable}}{optional \code{\link{GCancellable}} object, \code{NULL} to ignore. }
 
11
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
12
}
 
13
\details{If \code{cancellable} is not \code{NULL}, then the operation can be cancelled by
 
14
triggering the cancellable object from another thread. If the operation
 
15
was cancelled, the error \code{G_IO_ERROR_CANCELLED} will be returned.}
 
16
\value{
 
17
A list containing the following elements:
 
18
\item{retval}{[logical] \code{TRUE} if successful. If an error
 
19
    has occurred, this function will return \code{FALSE} and set \code{error}
 
20
    appropriately if present.}
 
21
\item{\verb{error}}{a \code{\link{GError}} location to store the error occuring, or \code{NULL} to 
 
22
ignore.}
 
23
}
 
24
\author{Derived by RGtkGen from GTK+ documentation}
 
25
\keyword{internal}