Difference between revisions of "RAT()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=RAT()=
 
 
 
==Class==
 
String Data
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to search for a substring
 
Function to search for a substring
Line 11: Line 4:
  
 
==Syntax==
 
==Syntax==
RAT(<expC1>, <expC2> | <memofield> [<expN>])
+
RAT(<expC1>, <expC2> | <memofield> [, <expN>])
  
  
 
==See Also==
 
==See Also==
[[AT()]], [[ATNEXT()]], [[INLIST()]], [[LEFT()]], [[OCCURS()]], [[RIGHT()]], [[STR()]], [[STREXTRACT()]], [[STRTRAN()]], [[STUFF()]], [[SUBSTR()]]
+
[[AT()]], [[ATNEXT()]], [[INLIST()]], [[LEFT()]], [[OCCURS()]], [[RIGHT()]], [[SET STRESCAPE]], [[STR()]], [[STREXTRACT()]], [[STRTRAN()]], [[STUFF()]], [[SUBSTR()]]
  
  
 
==Description==
 
==Description==
The RAT() function is a substring search function.  It will search <expC2>  or the specified memo field for the last occurrence of <expC1>  and return the starting position as a numeric value.  If the substring is not contained within the second character expression or memo field, then the function returns the value 0.  The leftmost character of a string is in character position 1.  The RAT() function will return the starting position of the specified occurrence of <expC1> when the optional numeric expression <expN> is used.  The RAT() function is particularly useful in conjunction with RIGHT() or SUBSTR functions for locating starting points for text extraction.
+
The RAT() function is a substring search function.  It will search <expC2>  or the specified memo field for the last occurrence of <expC1>  and return the starting position as a numeric value.  If the substring is not contained within the second character expression or memo field, then the function returns the value 0.  The leftmost character of a string is in character position 1.  The RAT() function will return the starting position of the specified occurrence of <expC1> when the optional numeric expression <expN> is used.  The RAT() function is particularly useful in conjunction with RIGHT() or SUBSTR() functions for locating starting points for text extraction.
  
  
Line 36: Line 29:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:String Data]]
 +
[[Category:String Data Functions]]

Latest revision as of 09:28, 23 July 2010

Purpose

Function to search for a substring


Syntax

RAT(<expC1>, <expC2> | <memofield> [, <expN>])


See Also

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


Description

The RAT() function is a substring search function. It will search <expC2> or the specified memo field for the last occurrence of <expC1> and return the starting position as a numeric value. If the substring is not contained within the second character expression or memo field, then the function returns the value 0. The leftmost character of a string is in character position 1. The RAT() function will return the starting position of the specified occurrence of <expC1> when the optional numeric expression <expN> is used. The RAT() function is particularly useful in conjunction with RIGHT() or SUBSTR() functions for locating starting points for text extraction.


Example

? rat("is", "is is is")
         7
cString1 = "fa"
cString2 = "Recital is fast"
? rat(cString1, cString2)
        12
?rat("Step", notes, 8)
        24


Products

Recital, Recital Server