File: getParameter.HttpRequest.Rd

package info (click to toggle)
r-cran-r.rsp 0.46.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,472 kB
  • sloc: javascript: 612; tcl: 304; sh: 18; makefile: 16
file content (49 lines) | stat: -rw-r--r-- 1,462 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  HttpRequest.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{getParameter.HttpRequest}
\alias{getParameter.HttpRequest}
\alias{HttpRequest.getParameter}
\alias{getParameter,HttpRequest-method}

\title{Gets a parameter}

\description{
 Gets a parameter.
}

\usage{
\method{getParameter}{HttpRequest}(this, name, default=NULL, drop=TRUE, ...)
}

\arguments{
  \item{name}{Name of parameter to be retrieved.}
  \item{default}{Value to be returned if parameter is missing.}
  \item{drop}{If \code{\link[base:logical]{TRUE}} and the number of returned values is one, then
   this single value is returned, otherwise a named \code{\link[base]{vector}}.}
  \item{...}{Additional arguments passed to \code{\link[R.rsp:getParameters.HttpRequest]{*getParameters}()}.}
}

\value{
 Returns the value(s) of the parameter either as a single value or
 as a named \code{\link[base]{list}}.
 If the parameter does not exist, the default value is returned as is.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[R.rsp:hasParameter.HttpRequest]{*hasParameter}()}.
  \code{\link[R.rsp:getParameters.HttpRequest]{*getParameters}()}.
  For more information see \code{\link{HttpRequest}}.
}


\keyword{internal}
\keyword{methods}
\keyword{IO}