Method HttpRequestMessage() :getParameter()

Gets the value of a HTTP parameter by its name.

 
:getParameter( <cName> ) --> cValue | NIL

<nName>

A character string with the name of the parameter.

:getParameter() returns a character string with the value of the parameter. If the parameter is empty, return is the empty string (""). For undefined parameters,:setParameter()returns NIL.

The method :getParameter() gets the value of a HTTP parameter given its name. For parameters which appear several times in the query string (multiple parameter values), only the value of the first parameter is returned. The method :getParameters() can be used for retrieving multiple parameter values.

The methods :addParameter(), :delParameter(), :getParameter(), :getParameters() and their respective :set..() counterparts allow direct and easy manipulation of name-value pairs that are transferred in the Http request. The parameters are transferred according to the request method. For the request method "GET", the parameters are transferred as name-value pairs in the query string. If the request method is "POST" or "PUT", the parameters are converted according to the content type and transferred in the body of the Http request.

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Method HttpRequestMessage() :getParameter() Foundation