The R Project SVN R

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
42333 ripley 1 
% File src/library/utils/man/windows/getWindowsHandle.Rd
2 
% Part of the R package, http://www.R-project.org
59039 ripley 3 
% Copyright 1995-2007 R Core Team
42333 ripley 4 
% Distributed under GPL 2 or later
5 
 
29227 murdoch 6 
\name{getWindowsHandle}
56186 murdoch 7 
\alias{getWindowsHandle}
29227 murdoch 8 
\title{Get a Windows Handle}
9 
\description{
42256 murdoch 10 
  Get the Windows handle of a window or of the \R{} process.
29227 murdoch 11 
}
12 
\usage{
13 
getWindowsHandle(which = "Console")
14 
}
15 
\arguments{
61433 ripley 16 
  \item{which}{A string (see below), or the number of a
49972 ripley 17 
                graphics device window}
29227 murdoch 18 
}
19 
\details{
42256 murdoch 20 
  \code{getWindowsHandle} gets the Windows handle.
42248 ripley 21 
  Possible choices for \code{which} are:
29227 murdoch 22 
  \tabular{ll}{
23 
  \code{"Console"} \tab The console window handle. \cr
24 
  \code{"Frame"}   \tab The MDI frame window handle. \cr
25 
  \code{"Process"} \tab The process pseudo-handle. \cr
61433 ripley 26 
  A device number \tab The window handle of a graphics device
29227 murdoch 27 
 }
61433 ripley 28 
  These values are not normally useful to users, but may be used by
42256 murdoch 29 
  developers making add-ons to \R{}.
61433 ripley 30 
 
31 
  \code{NULL} is returned for the Frame handle if not running in MDI mode,
32 
  for the Console handle when running Rterm, for any unrecognized
33 
  string for \code{which}, or for a graphics device with no
29227 murdoch 34 
  corresponding window.
61433 ripley 35 
 
36 
  Other windows (help browsers, etc.) are not accessible
42256 murdoch 37 
  through this function.
29227 murdoch 38 
}
61433 ripley 39 
\note{
42256 murdoch 40 
  As from R 2.6.0, this function returns an external pointer rather than
41 
  an integer value, and \code{which = "ProcessId"} is no longer supported.
42 
  Use \code{\link{Sys.getpid}} for the latter.
43 
}
29227 murdoch 44 
\value{
42256 murdoch 45 
  An external pointer holding the Windows handle, or \code{NULL}.
29227 murdoch 46 
}
49479 murdoch 47 
\seealso{\code{\link{getIdentification}}, \code{\link{getWindowsHandles}}}
29227 murdoch 48 
\examples{
49 
getWindowsHandle()
50 
}
51 
\keyword{utilities}