BeforAtNum()

Returns string portion before nth occurence of substring

Syntax

      BeforAtNum( <cStringToMatch>, <cString>, [<nCounter>],
                  [<nIgnore>] ) --> cRestString

Arguments

<cStringToMatch> is the substring scanned for <cString> is the scanned string [<nCounter>] determines how many occurences are of <cStringToMatch> in <cString> are searched Default: search last occurence [<nIgnore>] determines how many character from the start should be ignored in the search Default: 0

Returns

<cRestString> the portion of <cString> before the <nCounter>th occurence of <cStringToMatch> in <cString> If such a string does not exist, an empty string is returned.

Description

This function scans <cString> for <cStringToMatch>. After the <nCounter>th match (or the last one, depending on the value of <nCounter>) has been found, the portion of <cString> before that match will be returned. If there aren’t enough matches or the last match is identical to the start of <cString> (i.e. the last match is the first match), an empty string will be returned. After a match has been found, the function continues to scan after that match if the CSetAtMuPa() switch is turned off, with the second character of the matched substring otherwise. The function will also consider the settings of SetAtLike().

Examples

      ? BeforAtNum( "!", "What is the answer ? 4 ! 5 !" ) 
                       // -> "What is the answer ? 4 ! 5 "
      ? BeforAtNum( "!", "What is the answer ? 4 ! 5 ?" ) 
                       // -> "What is the answer ? 4 "
      <TODO: add some examples here with csetatmupa() and setatlike()>

Tests

      BeforAtNum( "..", "..This..is..a..test!" ) == "..This..is..a"
      BeforAtNum( "..", "..This..is..a..test!", 2 ) == "..This"
      BeforAtNum( "..", "..This..is..a..test!", 2, 2 ) == "..This..is"

Compliance

BeforAtNum() is compatible with CT3’s BeforAtNum().

Platforms

All

Files

Source is atnum.c, library is ct3.

Seealso

AtNum() AfterAtNum() CSetAtMuPa() SetAtLike()