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
100
101
102
103
104
105
106
|
<?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_get">
<refmeta>
<refentrytitle>connection_get</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>connection_get</refname>
<refpurpose>Get connection variable</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_connection_get">
<funcprototype id="fproto_connection_get">
<funcdef>any <function>connection_get</function></funcdef>
<paramdef>in <parameter>name</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_connection_get"><title>Description</title>
<para><function>connection_get</function> is used to retrieve values
stored within the current connection context. See
<link linkend="fn_connection_set"><function>connection_set</function></link>
for a more detailed discussion of connection variables.</para></refsect1>
<refsect1 id="params_connection_get"><title>Parameters</title>
<refsect2><title>name</title>
<para>Name of the connection variable</para></refsect2>
</refsect1>
<refsect1 id="ret_connection_get"><title>Return Values</title>
<para>A value associated to the connection by connection_set in the datatype of the original value. If the variable does not exist, a NULL is returned.</para>
</refsect1>
<!--
<refsect1 id="errors_connection_get"><title>Errors</title>
<table><title>Errors signalled by <function>connection_get</function></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_connection_get"><title>Examples</title>
<example id="ex_connection_var1"><title>Setting and Retrieving Connection Variables</title>
<programlisting>
SQL> select connection_get('var_demo');
callret
VARCHAR
__________________________________________________________________
NULL
SQL> connection_set('var_demo', 'some arb data');
SQL> select connection_get('var_demo');
callret
VARCHAR
__________________________________________________________________
some arb data
</programlisting>
<para>
In a VSP page...
</para>
<programlisting>
<?vsp
declare id integer;
declare saved_req any;
id := connection_get ('ID');
saved_req := connection_set ('saved_request');
?>
</programlisting>
</example>
</refsect1>
<refsect1 id="seealso_connection_get"><title>See Also</title>
<para><link linkend="fn_connection_set">connection_set</link></para>
</refsect1>
</refentry>
|
