Classes

Method HttpMessage() :getParameter() Foundation

Gets the value of a HTTP parameter by its name.

Syntax
 
METHOD :getParameter( <cName> ) --> cValue | NIL
Parameters
<nName>
A character string with the name of the parameter.
Return

: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.

Description

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.

HTTP parameters are transferred as part of the query string. The methods :addParameter(), :delParameter(), :getParameter(), :getParameters() and their respective :set..() counterparts allow direct and easy manipulation of this part of the HTTP query string. Use the method :getQueryString() for obtaining a reference to the complete string.

Feedback

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.