The R Project SVN R

Rev

Rev 60392 | Rev 68948 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 60392 Rev 61433
Line 29... Line 29...
29
getNativeSymbolInfo(name, PACKAGE, unlist = TRUE,
29
getNativeSymbolInfo(name, PACKAGE, unlist = TRUE,
30
                    withRegistrationInfo = FALSE)
30
                    withRegistrationInfo = FALSE)
31
}
31
}
32
\arguments{
32
\arguments{
33
  \item{name}{the name(s) of the native symbol(s).}
33
  \item{name}{the name(s) of the native symbol(s).}
34
  
34
 
35
  \item{PACKAGE}{an optional argument that specifies to which
35
  \item{PACKAGE}{an optional argument that specifies to which
36
    DLL to restrict the search for this symbol.  If this is
36
    DLL to restrict the search for this symbol.  If this is
37
    \code{"base"}, we search in the \R executable itself.}
37
    \code{"base"}, we search in the \R executable itself.}
38
  
38
 
39
  \item{unlist}{a logical value which controls how the result is
39
  \item{unlist}{a logical value which controls how the result is
40
    returned if the function is called with the name of a single symbol.
40
    returned if the function is called with the name of a single symbol.
41
    If \code{unlist} is \code{TRUE} and the number of symbol names in
41
    If \code{unlist} is \code{TRUE} and the number of symbol names in
42
    \code{name} is one, then the \code{NativeSymbolInfo} object
42
    \code{name} is one, then the \code{NativeSymbolInfo} object
43
    is returned.  If it is \code{FALSE}, then a list
43
    is returned.  If it is \code{FALSE}, then a list
44
    of \code{NativeSymbolInfo} objects is returned.
44
    of \code{NativeSymbolInfo} objects is returned.
45
    This is ignored if the number of symbols passed in \code{name} is
45
    This is ignored if the number of symbols passed in \code{name} is
46
    more than one. 
46
    more than one.
47
    To be compatible with earlier versions of this function, this
47
    To be compatible with earlier versions of this function, this
48
    defaults to \code{TRUE}.
48
    defaults to \code{TRUE}.
49
  }
49
  }
50
  \item{withRegistrationInfo}{a logical value indicating whether, if
50
  \item{withRegistrationInfo}{a logical value indicating whether, if
51
    \code{TRUE}, to return information that was registered with \R about
51
    \code{TRUE}, to return information that was registered with \R about
Line 88... Line 88...
88
        the different native interface functions.}
88
        the different native interface functions.}
89
      \item{path}{the fully qualified name of the DLL.}
89
      \item{path}{the fully qualified name of the DLL.}
90
      \item{dynamicLookup}{a logical value indicating whether dynamic
90
      \item{dynamicLookup}{a logical value indicating whether dynamic
91
        resolution is used when looking for symbols in this library,
91
        resolution is used when looking for symbols in this library,
92
        or only registered routines can be located.}
92
        or only registered routines can be located.}
93
    }    
93
    }
94
  }
94
  }
95
  If the routine was explicitly registered by the dynamically loaded
95
  If the routine was explicitly registered by the dynamically loaded
96
  library, the list contains a fourth field
96
  library, the list contains a fourth field
97
  \item{numParameters}{the number of arguments that should be passed in
97
  \item{numParameters}{the number of arguments that should be passed in
98
    a call to this routine.}
98
    a call to this routine.}
Line 109... Line 109...
109
}
109
}
110
\references{
110
\references{
111
  For information about registering native routines,
111
  For information about registering native routines,
112
  see \dQuote{In Search of C/C++ & FORTRAN Routines},
112
  see \dQuote{In Search of C/C++ & FORTRAN Routines},
113
  R-News, volume 1, number 3, 2001, p20--23
113
  R-News, volume 1, number 3, 2001, p20--23
114
  (\url{http://cran.r-project.org/doc/Rnews/Rnews_2001-3.pdf}).  
114
  (\url{http://cran.r-project.org/doc/Rnews/Rnews_2001-3.pdf}).
115
}
115
}
116
\author{Duncan Temple Lang}
116
\author{Duncan Temple Lang}
117
\note{
117
\note{
118
  One motivation for accessing this reflectance information is to be
118
  One motivation for accessing this reflectance information is to be
119
  able to pass native routines to C routines as function pointers in C.
119
  able to pass native routines to C routines as function pointers in C.
Line 129... Line 129...
129
  \code{\link{is.loaded}},
129
  \code{\link{is.loaded}},
130
  \code{\link{.C}},
130
  \code{\link{.C}},
131
  \code{\link{.Fortran}},
131
  \code{\link{.Fortran}},
132
  \code{\link{.External}},
132
  \code{\link{.External}},
133
  \code{\link{.Call}},
133
  \code{\link{.Call}},
134
  \code{\link{dyn.load}}.  
134
  \code{\link{dyn.load}}.
135
}
135
}
136
 
136
 
137
% \examples{
137
% \examples{
138
% library(stats) # normally loaded
138
% library(stats) # normally loaded
139
% getNativeSymbolInfo("dansari")
139
% getNativeSymbolInfo("dansari")