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
|
<?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_isarray">
<refmeta>
<refentrytitle>isarray</refentrytitle>
<refmiscinfo>array</refmiscinfo>
<refmiscinfo>type</refmiscinfo>
</refmeta>
<refnamediv>
<refname>isarray</refname>
<refpurpose>Check for a valid array</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_isarray">
<funcprototype id="fproto_isarray">
<funcdef>boolean <function>isarray</function></funcdef>
<paramdef>in <parameter>x</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_isarray"><title>Description</title>
<para>isarray is true if the argument is a valid argument to aref.
This is the case for any string or vector.</para>
</refsect1>
<refsect1 id="params_isarray"><title>Parameters</title>
<refsect2>
<title>x</title>
<para>The variable to be checked.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_isarray"><title>Return Values</title>
<para>1 - if arg is an array (vector()) or string (varchar, char) otherwise return 0.</para>
</refsect1>
<refsect1 id="errors_isarray"><title>Errors</title>
<para>No error, it always succeeds.</para>
</refsect1>
</refentry>
|