Difference between revisions of "String.match"

From GiderosMobile
Line 2: Line 2:
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
=== Description ===
 
=== Description ===
Find the first match of the regular expression "pattern" in "str", starting at position "index".
+
<translate>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).
 
The starting position (index) is optional, and defaults to 1 (the start of the string).
Line 13: Line 13:
  
  
print (string.match ("You see dogs and cats", "s..")) --> see
+
print (string.match ("You see dogs and cats", "s..")) --> see</translate>
 
<source lang="lua">
 
<source lang="lua">
 
(string) = string.match(string,pattern)
 
(string) = string.match(string,pattern)
 
</source>
 
</source>
 
=== Parameters ===
 
=== Parameters ===
'''string''': (String) Any string. <br/>
+
'''string''': (String) <translate>Any string.</translate> <br/>
'''pattern''': (String) Specifies the pattern to match. <br/>
+
'''pattern''': (String) <translate>Specifies the pattern to match.</translate> <br/>
 
=== Return values ===
 
=== Return values ===
'''Returns''' (string) String matching pattern.<br/>
+
'''Returns''' (string) <translate>String matching pattern.</translate><br/>

Revision as of 14:32, 23 August 2018

Available since: Gideros 2011.6

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.

This is similar to string.find, except that the starting and ending index are not returned.


print (string.match ("You see dogs and cats", "s..")) --> see

(string) = string.match(string,pattern)

Parameters

string: (String) Any string.
pattern: (String) Specifies the pattern to match.

Return values

Returns (string) String matching pattern.