Difference between revisions of "String.match"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | ''' | + | '''Available since:''' Gideros 2011.6<br/> |
| − | ''' | + | '''Class:''' [[string]]<br/> |
| − | |||
| − | |||
| − | The starting position (index) is optional, and defaults to 1 (the start of the string). | + | === Description === |
| + | Finds 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. |
| + | <syntaxhighlight lang="lua"> | ||
| + | (string) = string.match(string,pattern) | ||
| + | </syntaxhighlight> | ||
| + | '''note''': this is similar to string.find, except that the starting and ending index are not returned. | ||
| − | + | === Parameters === | |
| + | '''string''': (String) any string<br/> | ||
| + | '''pattern''': (String) specifies the pattern to match<br/> | ||
| − | + | === Return values === | |
| + | '''Returns''' (string) string matching pattern<br/> | ||
| + | === Examples === | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | print (string.match ("You see dogs and cats", "s..")) -- see | ||
| + | -- checks if a string contains any letters | ||
| + | local mystring = "0123456" | ||
| + | print(mystring:match("%a")) -- false | ||
| + | </syntaxhighlight> | ||
| − | + | {{String}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 15:33, 13 July 2023
Available since: Gideros 2011.6
Class: string
Description
Finds 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
Examples
print (string.match ("You see dogs and cats", "s..")) -- see
-- checks if a string contains any letters
local mystring = "0123456"
print(mystring:match("%a")) -- false
