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
|
<?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="xpf_function_available">
<refmeta>
<refentrytitle>function-available</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>function-available</refname>
<refpurpose>Returns true if XPATH extension function with the requested name is defined in the XPATH Processor, otherwise returns false.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_function_available">
<funcprototype id="xpf_proto_function_available">
<funcdef>boolean <function>function-available</function></funcdef>
<paramdef><parameter>funname</parameter> string</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_function_available"><title>Description</title>
<para>
The function returns true if XPATH Processor can execute
XPATH extension function with the name specified by
<parameter>funname</parameter> argument.
If such function is not defined, function-available returns false.
</para>
</refsect1>
<refsect1 id="xpf_params_function_available"><title>Parameters</title>
<refsect2><title>funname</title>
<para>The name of XPATH extension function</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_function_available"><title>Return Types</title><para>Boolean</para></refsect1>
<refsect1 id="xpf_examples_function_available"><title>Examples</title>
<example id="xpf_ex_function_available"><title></title>
<para>This expression should return false.</para>
<screen>function-available('http://example.com/Virtuoso/nosuchfunction')</screen>
</example>
</refsect1>
<refsect1 id="xpf_seealso_function_available"><title>See Also</title>
<para><link linkend="fn_xpf_extension">xpf_extension()</link></para>
</refsect1>
</refentry>
|