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
91
92
93
94
95
96
97
98
99
|
<?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_connection_vars_set">
<refmeta>
<refentrytitle>connection_vars_set</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>connection_vars_set</refname>
<refpurpose>set all connection variables</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_connection_vars_set">
<funcprototype id="fproto_connection_vars_set">
<funcdef><function>connection_vars_set</function></funcdef>
<paramdef>in <parameter>var_array</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_connection_vars_set"><title>Description</title>
<para>This function clears all connection variables for current
session and sets new ones defined in the array passed as parameter.
</para>
<para>Connection variables do not persist across sessions, one
may maintain persistence of variables by storing them in a database
table, as discussed in <link linkend="wssessman">Session Variables</link>
-section.</para>
</refsect1>
<refsect1 id="params_connection_vars_set"><title>Parameters</title>
<refsect2><title>var_array</title>
<para>An <type>array</type> of even number of elements, containing
name-value pairs. NULL, will cause all connection variables for current
connection to be erased.</para>
</refsect2>
</refsect1>
<refsect1 id="examples_connection_vars_set"><title>Examples</title>
<example id="ex_connection_vars_set"><title>Usage</title>
<screen>
<?vsp
connection_vars_set (vector ('ID', 12));
?>
</screen>
</example>
<example id="ex_connection_vars_set2"><title>Setting and Retrieving Connection Variables</title>
<screen>
SQL>connection_vars_set(vector('v1', 'a', 'v2', 1));
Done. -- 0 msec.
SQL> select connection_vars();
callret
VARCHAR
___________________________________________________________________________
vector(0x004e419c,0x004e40c4,0x004dec9c,1)
1 Rows. -- 70 msec.
SQL>select aref(connection_vars(),0),
aref(connection_vars(), 1),
aref(connection_vars(), 2),
aref(connection_vars(), 3);
callret callret callret callret
VARCHAR VARCHAR VARCHAR VARCHAR
_______________________________________________________________________________
v1 a v2 1
1 Rows. -- 80 msec.
</screen>
</example>
</refsect1>
<refsect1 id="seealso_connection_vars_set"><title>See Also</title>
<para><link linkend="fn_connection_get">connection_get</link></para>
<para><link linkend="fn_connection_set">connection_set</link></para>
<para><link linkend="fn_connection_vars">connection_vars</link></para>
</refsect1>
</refentry>
|
