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
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<?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_aref">
<refmeta>
<refentrytitle>aref</refentrytitle>
<refmiscinfo>array</refmiscinfo>
</refmeta>
<refnamediv>
<refname>aref</refname>
<refpurpose>returns specific element of an array or string</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_aref">
<funcprototype id="fproto_aref">
<funcdef><function>aref</function></funcdef>
<paramdef><parameter>arg</parameter> any</paramdef>
<paramdef><parameter>nth</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_aref"><title>Description</title>
<para><function>aref</function> returns the <parameter>nth</parameter>
element of an <type>array</type>, <type>string</type> or
<type>string_session</type>, where <parameter>nth</parameter>
is a zero-based index. If the first argument is a <type>string</type> or
<type>string_session</type>, the <type>integer</type> ASCII value of the
<parameter>nth</parameter> character is returned. If the first argument is an
array of <type>any</type>, then the corresponding element is returned.</para>
</refsect1>
<refsect1 id="params_aref"><title>Parameters</title>
<refsect2><title><parameter>arg</parameter></title>
<para>
<type>array</type>, <type>vector</type> or <type>string</type>.
</para>
</refsect2>
<refsect2><title><parameter>nth</parameter></title>
<para><type>integer</type> zero-based index.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_aref"><title>Return Values</title>
<para>An <type>integer</type> character code or <parameter>nth</parameter>
element as whatever type the element is if
<parameter>arg</parameter> is an array or vector (heterogeneous array.)</para>
</refsect1>
<refsect1 id="errors_aref"><title>Errors</title>
<table><title>Errors signalled by aref</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>22003</errorcode></entry>
<entry><errorcode>SR017</errorcode></entry>
<entry><errorname>aref: Bad array subscript (zero-based) %d for an arg of type %s
(%d) and length %d.</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>22023</errorcode></entry>
<entry><errorcode>SR000</errorcode></entry>
<entry><errorname>aref expects an array or vector, not an arg of type %d.</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_aref"><title>Examples</title>
<example id="ex_aref_1"><title>Simple examples</title>
<screen>
SQL> select aref ('Abacus', 0);
callret
VARCHAR
_______________________________________________________________________________
65
1 Rows. -- 3 msec.
SQL> select aref (vector ('Primero', 2, 3.333), 2);
callret
VARCHAR
_______________________________________________________________________________
3.333
1 Rows. -- 4 msec.
SQL>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_aref"><title>See Also</title>
<para>
<link linkend="fn_vector"><function>vector</function></link>
<link linkend="fn_aset"><function>aset</function></link>
<link linkend="fn_ascii"><function>ascii</function></link>
</para>
</refsect1>
</refentry>
|
