← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/gSocketAddressToNative.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/gSocketAddressToNative.Rd
 
1
\alias{gSocketAddressToNative}
 
2
\name{gSocketAddressToNative}
 
3
\title{gSocketAddressToNative}
 
4
\description{Converts a \code{\link{GSocketAddress}} to a native \verb{struct
 
5
sockaddr}, which can be passed to low-level functions like
 
6
\code{connect()} or \code{bind()}.}
 
7
\usage{gSocketAddressToNative(object, dest, destlen, .errwarn = TRUE)}
 
8
\arguments{
 
9
\item{\verb{object}}{a \code{\link{GSocketAddress}}}
 
10
\item{\verb{dest}}{a pointer to a memory location that will contain the native
 
11
\verb{structsockaddr}.}
 
12
\item{\verb{destlen}}{the size of \code{dest}. Must be at least as large as
 
13
\code{\link{gSocketAddressGetNativeSize}}.}
 
14
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
15
}
 
16
\details{If not enough space is availible, a \code{G_IO_ERROR_NO_SPACE} error is
 
17
returned. If the address type is not known on the system
 
18
then a \code{G_IO_ERROR_NOT_SUPPORTED} error is returned.
 
19
  Since 2.22}
 
20
\value{
 
21
A list containing the following elements:
 
22
\item{retval}{[logical] \code{TRUE} if \code{dest} was filled in, \code{FALSE} on error}
 
23
\item{\verb{error}}{\code{\link{GError}} for error reporting, or \code{NULL} to ignore.}
 
24
}
 
25
\author{Derived by RGtkGen from GTK+ documentation}
 
26
\keyword{internal}