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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_http_param">
<refmeta>
<refentrytitle>http_param</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_param</refname>
<refpurpose>returns value of a HTML form parameter in VSP context</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_param">
<funcprototype id="fproto_http_param">
<funcdef><function>http_param</function></funcdef>
<paramdef><optional>in <parameter>name</parameter> varchar</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_param"><title>Description</title>
<para>This function is used to return value of a HTML form parameter in VSP context.
It's almost like call get_keyword ('name', params) used in VSP programming.
When 'name' parameter is not supplied, the result of http_param() call will be
all parameters, as they are contained in 'params' parameter of the VSP pages.
This function is useful in HTTP authentication PL hook, as in this place there
is no 'params' argument.
</para>
</refsect1>
<refsect1 id="params_http_param"><title>Parameters</title>
<refsect2><title>name</title>
<para>A string with name of the parameter to return</para>
</refsect2>
</refsect1>
<refsect1 id="ret_http_param"><title>Return Types</title><para>
Returns value of a HTML form parameter, or array of all parameters.
</para></refsect1>
<!--refsect1 id="errors_http_param"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1-->
<!--
<refsect1 id="examples_http_param"><title>Examples</title>
<example id="ex_http_param"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_http_param"><title>See Also</title>
<para>
<link linkend="">VSP pages</link>
<link linkend="fn_vhost_define"><function>vhost_define()</function></link>
</para>
</refsect1>
</refentry>
|
