File: xpf_substring_before.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (68 lines) | stat: -rw-r--r-- 3,127 bytes parent folder | download | duplicates (2)
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
<?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_substring_before">
  <refmeta> 
    <refentrytitle>substring-before</refentrytitle> 
    <refmiscinfo>XPATH</refmiscinfo>
  </refmeta> 
  <refnamediv> 
    <refname>substring-before</refname>
    <refpurpose>Returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="xpf_syn_substring_before">
      <funcprototype id="xpf_proto_substring_before">
        <funcdef>string <function>substring-before</function></funcdef>
	<paramdef><parameter>source_strg</parameter> string</paramdef>
	<paramdef><parameter>sub_strg</parameter> string</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="xpf_desc_substring_before"><title>Description</title>
<para>
If the <parameter>source_strg</parameter> does not contain <parameter>sub_strg</parameter>,
the function returns the empty string.
Otherwise, it finds the first occurrence of <parameter>sub_strg</parameter> and returns
the pert of <parameter>source_strg</parameter> that precedes the occurrence.
If any argument is not a string, it is converted to string using rules for string() XPATH function.
</para>
</refsect1>
  <refsect1 id="xpf_params_substring_before"><title>Parameters</title>
    <refsect2><title>source_strg</title>
      <para>String where the search is performed</para></refsect2>
    <refsect2><title>sub_strg</title>
      <para>String to search</para></refsect2>
  </refsect1>
  <refsect1 id="xpf_ret_substring_before"><title>Return Types</title><para>String</para></refsect1>
  <refsect1 id="xpf_examples_substring_before"><title>Examples</title>
    <example id="xpf_ex_substring_before"><title></title>
      <para>Extract year (&quot;1999&quot; substring) from ISO date string</para>
      <screen>substring-before('1999-12-31','-')</screen>
    </example>
  </refsect1>
  <refsect1 id="xpf_seealso_substring_before"><title>See Also</title>
    <para><link linkend="xpf_string">string()</link><link linkend="xpf_substring">substring()</link><link linkend="xpf_substring_after">substring-after()</link></para>
  </refsect1>
</refentry>