modified: SpatialOmicsCoord.py
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / substr
blob0ec4188ec599b9bcd0fe5162ad3fcd262b15926e
1 NAME
2     substr - extract a substring of given string
4 SYNOPSIS
5     substr(str, pos, len)
7 TYPES
8     str         string
9     pos         nonnegative integer
10     len         nonnegative integer
12     return      string
14 DESCRIPTION
15     If pos > length of str or len is zero, the null string "" is returned.
17     If 1 <= pos <= strlen(str), substr(str, pos, len) returns the
18     string of length min(strlen(str) - pos + 1, len) formed by
19     consecutive characters of str starting at position pos, i.e. the
20     string has length len if this is possible, otherwise it ends with
21     the last character of str.  (The first character has pos = 1, the
22     second pos = 2, etc.)
24     If pos = 0, the result is the same as for pos = 1.
26 EXAMPLE
27     ; A = "abcde";
28     ; print substr(A,0,2), substr(A,1,2), substr(A,4,1), substr(A,3,5)
29     ab ab d cde
31 LIMITS
32     none
34 LINK LIBRARY
35     none
37 SEE ALSO
38     strcat, strcpy, strerror, strlen, strncmp, strncpy, strpos,
39     strprintf, strscan, strscanf
41 ## Copyright (C) 1999-2006  Ernest Bowen
43 ## Calc is open software; you can redistribute it and/or modify it under
44 ## the terms of the version 2.1 of the GNU Lesser General Public License
45 ## as published by the Free Software Foundation.
47 ## Calc is distributed in the hope that it will be useful, but WITHOUT
48 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
49 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
50 ## Public License for more details.
52 ## A copy of version 2.1 of the GNU Lesser General Public License is
53 ## distributed with calc under the filename COPYING-LGPL.  You should have
54 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
55 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
57 ## @(#) $Revision: 30.1 $
58 ## @(#) $Id: substr,v 30.1 2007/03/16 11:10:42 chongo Exp $
59 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/substr,v $
61 ## Under source code control:   1995/10/05 04:52:27
62 ## File existed as early as:    1995
64 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
65 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/