Difference between revisions of "String.match"
From GiderosMobile
m (formatting) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
'''<translate>Available since</translate>:''' Gideros 2011.6<br/> | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> | ||
'''<translate>Class</translate>:''' [[Special:MyLanguage/string|string]]<br/> | '''<translate>Class</translate>:''' [[Special:MyLanguage/string|string]]<br/> | ||
| − | |||
| − | |||
| − | The starting position (index) is optional, and defaults to 1 (the start of the string). | + | === Description === |
| + | Find the first match of the regular expression "pattern" in "str", starting at position "index". The starting position (index) is optional, and defaults to 1 (the start of the string). | ||
| − | If found, returns any captures in the pattern. If no captures were specified the entire matching string is returned. | + | If found, returns any captures in the pattern. If no captures were specified the entire matching string is returned. If not found, returns nil. |
| + | <source lang="lua"> | ||
| + | (string) = string.match(string,pattern) | ||
| + | </source> | ||
| + | '''note''': this is similar to string.find, except that the starting and ending index are not returned. | ||
| − | + | === Parameters === | |
| + | '''string''': (String) <translate>any string</translate> <br/> | ||
| + | '''pattern''': (String) <translate>specifies the pattern to match</translate> <br/> | ||
| − | + | === Return values === | |
| + | '''<translate>Returns</translate>''' (string) <translate>String matching pattern</translate><br/> | ||
| − | + | === Example === | |
| − | |||
<source lang="lua"> | <source lang="lua"> | ||
| − | ( | + | print (string.match ("You see dogs and cats", "s..")) -- see |
</source> | </source> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{String}} | {{String}} | ||
Revision as of 04:14, 24 August 2020
Available since: Gideros 2011.6
Class: string
Description
Find the first match of the regular expression "pattern" in "str", starting at position "index". The starting position (index) is optional, and defaults to 1 (the start of the string).
If found, returns any captures in the pattern. If no captures were specified the entire matching string is returned. If not found, returns nil.
(string) = string.match(string,pattern)
note: this is similar to string.find, except that the starting and ending index are not returned.
Parameters
string: (String) any string
pattern: (String) specifies the pattern to match
Return values
Returns (string) String matching pattern
Example
print (string.match ("You see dogs and cats", "s..")) -- see
