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
|
<?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_left">
<refmeta>
<refentrytitle>left</refentrytitle>
<refmiscinfo>string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>left</refname>
<refpurpose>returns substring taken from left of string argument</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_left">
<funcprototype id="fproto_left">
<funcdef><function>left</function></funcdef>
<paramdef><parameter>str</parameter> string</paramdef>
<paramdef><parameter>count</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_left"><title>Description</title>
<para>left returns a subsequence of string str, taking count characters from the
beginning of the string.
</para>
<para>
If count is zero an empty string '' is returned.
</para>
<para>
If length of str is less than count then a copy of the whole str is
returned.
</para>
<screen>left('AbracadabrA',4) -> 'Abra'</screen>
</refsect1>
</refentry>
|