Difference between revisions of "String.match"

From GiderosMobile
(added another example)
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
  
 
If found, returns any captures in the pattern. If no captures were specified the entire matching string is returned. If not found, returns nil.
 
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">
+
<syntaxhighlight lang="lua">
 
(string) = string.match(string,pattern)
 
(string) = string.match(string,pattern)
</source>
+
</syntaxhighlight>
 
'''note''': this is similar to string.find, except that the starting and ending index are not returned.
 
'''note''': this is similar to string.find, except that the starting and ending index are not returned.
  
Line 20: Line 20:
  
 
=== Examples ===
 
=== Examples ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
print (string.match ("You see dogs and cats", "s..")) -- see
 
print (string.match ("You see dogs and cats", "s..")) -- see
 
-- checks if a string contains any letters
 
-- checks if a string contains any letters
 
local mystring = "0123456"
 
local mystring = "0123456"
 
print(mystring:match("%a")) -- false
 
print(mystring:match("%a")) -- false
</source>
+
</syntaxhighlight>
  
 
{{String}}
 
{{String}}

Latest revision as of 14: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