RegExMatch

Inherits: Reference < Object

Category: Core

Brief Description

Contains the results of a regex search.

Member Functions

int get_end ( Variant name=0 ) const
int get_group_count ( ) const
Dictionary get_names ( ) const
int get_start ( Variant name=0 ) const
String get_string ( Variant name=0 ) const
Array get_strings ( ) const
String get_subject ( ) const

Description

Contains the results of a single regex match returned by RegEx.search and RegEx.search_all. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you.

Member Function Description

Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

Returns -1 if the group did not match or doesn’t exist.

  • int get_group_count ( ) const

Returns the number of capturing groups.

Returns a dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.

Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

Returns -1 if the group did not match or doesn’t exist.

Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

Returns an empty string if the group did not match or doesn’t exist.

  • Array get_strings ( ) const

Returns an Array of the match and its capturing groups.

  • String get_subject ( ) const

Returns the source string used with the search pattern to find this matching result.