Difference between revisions of "String.match"

From GiderosMobile
m (formatting)
m (remove language stuff)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/string|string]]<br/>
+
'''Class:''' [[string]]<br/>
  
 
=== Description ===
 
=== 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).
+
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.
 
If found, returns any captures in the pattern. If no captures were specified the entire matching string is returned. If not found, returns nil.
Line 13: Line 13:
  
 
=== Parameters ===
 
=== Parameters ===
'''string''': (String) <translate>any string</translate> <br/>
+
'''string''': (String) any string<br/>
'''pattern''': (String) <translate>specifies the pattern to match</translate> <br/>
+
'''pattern''': (String) specifies the pattern to match<br/>
  
 
=== Return values ===
 
=== Return values ===
'''<translate>Returns</translate>''' (string) <translate>String matching pattern</translate><br/>
+
'''Returns''' (string) string matching pattern<br/>
  
 
=== Example ===
 
=== Example ===

Revision as of 03:45, 24 February 2021

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

Example

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