Difference between revisions of "String.find"
| Line 2: | Line 2: | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
=== Description === | === Description === | ||
| − | Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then init must be given as well. | + | <translate>Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then init must be given as well. |
| − | If the pattern has captures, then in a successful match the captured values are also returned, after the two indices. | + | If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.</translate> |
<source lang="lua"> | <source lang="lua"> | ||
(numbers) = string.find(s,pattern,init,plain) | (numbers) = string.find(s,pattern,init,plain) | ||
</source> | </source> | ||
=== Parameters === | === Parameters === | ||
| − | '''s''': (string) string where to find a pattern <br/> | + | '''s''': (string) <translate>string where to find a pattern</translate> <br/> |
| − | '''pattern''': (string) pattern to find <br/> | + | '''pattern''': (string) <translate>pattern to find</translate> <br/> |
| − | '''init''': (number) index where to start searching for pattern '''optional'''<br/> | + | '''init''': (number) <translate>index where to start searching for pattern</translate> '''optional'''<br/> |
| − | '''plain''': (bool) if true, then it simply matches substring without any special symbols (default = false) '''optional'''<br/> | + | '''plain''': (bool) <translate>if true, then it simply matches substring without any special symbols (default = false)</translate> '''optional'''<br/> |
=== Return values === | === Return values === | ||
| − | '''Returns''' (numbers) indexes of occurrence of the pattern or nil<br/> | + | '''Returns''' (numbers) <translate>indexes of occurrence of the pattern or nil</translate><br/> |
Revision as of 13:33, 23 August 2018
Available since: Gideros 2011.6
Description
Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then init must be given as well.
If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.
(numbers) = string.find(s,pattern,init,plain)
Parameters
s: (string) string where to find a pattern
pattern: (string) pattern to find
init: (number) index where to start searching for pattern optional
plain: (bool) if true, then it simply matches substring without any special symbols (default = false) optional
Return values
Returns (numbers) indexes of occurrence of the pattern or nil
