Difference between revisions of "STRPOS()"

From Recital Documentation Wiki
Jump to: navigation, search
 
Line 1: Line 1:
{{YLM to do}}
 
 
 
==Class==
 
==Class==
 
+
String Data
  
  
 
==Purpose==
 
==Purpose==
 
+
Function to search for a substring
  
  
 
==Syntax==
 
==Syntax==
 
+
STRPOS(<expC1>, <expC2> [,<expN>])
  
  
 
==See Also==
 
==See Also==
 
+
[[AT]], [[ATNEXT()]], [[INLIST()]], [[LEFT()]], [[OCCURS()]], [[RAT()]], [[RIGHT()]], [[STR()]], [[STREXTRACT()]], [[STRTRAN()]], [[STUFF()]], [[SUBSTR()]]
  
  
 
==Description==
 
==Description==
 
+
STRPOS() is the substring search function.  It returns a number signifying the starting position of <expC2> in <expC1>.  If the substring is not contained within <expC2> or <memofield>, then the function returns the value 0.  The leftmost character of a string is in character position 1.  The optional numeric expression <expN> is used to specify an offset position at which to start the search (starting from 1).  The return value is based on the start of <expC1> regardless of the offset.  The STRPOS() function is particularly useful in conjunction with the LEFT() or SUBSTR() functions for locating starting points for extracting text from a string.
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
 
+
? at("is", "Recital is good")
 +
        9
 +
cString1 = "is"
 +
cString2 = "Recital is good"
 +
? at(cString1, cString2)
 +
        9
 
</code>
 
</code>
  
==Products==
 
  
 +
==Products==
 +
Recital Server, Recital
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:String Data]]
 +
[[Category:String Data Functions]]

Revision as of 13:09, 13 October 2009

Class

String Data


Purpose

Function to search for a substring


Syntax

STRPOS(<expC1>, <expC2> [,<expN>])


See Also

AT, ATNEXT(), INLIST(), LEFT(), OCCURS(), RAT(), RIGHT(), STR(), STREXTRACT(), STRTRAN(), STUFF(), SUBSTR()


Description

STRPOS() is the substring search function. It returns a number signifying the starting position of <expC2> in <expC1>. If the substring is not contained within <expC2> or <memofield>, then the function returns the value 0. The leftmost character of a string is in character position 1. The optional numeric expression <expN> is used to specify an offset position at which to start the search (starting from 1). The return value is based on the start of <expC1> regardless of the offset. The STRPOS() function is particularly useful in conjunction with the LEFT() or SUBSTR() functions for locating starting points for extracting text from a string.


Example

? at("is", "Recital is good") 
         9
cString1 = "is"
cString2 = "Recital is good" 
? at(cString1, cString2)
         9


Products

Recital Server, Recital