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
|
<?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_xper_locate_words">
<refmeta>
<refentrytitle>xper_locate_words</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xper_locate_words</refname>
<refpurpose>returns a smallest fragment of persistent XML entity object ('XPER entity') such that it contains some range of words in its text</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xper_doc">
<funcprototype id="fproto_xper_doc">
<funcdef><function>xper_locate_words</function></funcdef>
<paramdef>in <parameter>entity</parameter>any</paramdef>
<paramdef><optional>in <parameter>starting_word</parameter> integer</optional></paramdef>
<paramdef><optional>in <parameter>ending_word</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>This receives the XML entity and returns its fragment or signals an error.</para>
</refsect1>
<refsect1 id="params"><title>Parameters</title>
<refsect2><title>entity</title>
<para>A 'persistent XML' entity to be searched</para></refsect2>
<refsect2><title>starting_word</title>
<para>The number of the leftmost word which should be in the selected fragment</para></refsect2>
<refsect2><title>ending_word</title>
<para>The number of the rightmost word which should be in the selected fragment</para></refsect2>
</refsect1>
</refentry>
|
