expand_references


Description:

public string expand_references (string string_to_expand) throws RegexError

Returns a new string containing the text in string_to_expand with references and escape sequences expanded.

References refer to the last match done with string against regex and have the same syntax used by replace.

The string_to_expand must be UTF-8 encoded even if g_regex_raw was passed to Regex.

The backreferences are extracted from the string passed to the match function, so you cannot call this function after freeing the string.

this may be null in which case string_to_expand must not contain references. For instance "foo\n" does not refer to an actual pattern and '\n' merely will be replaced with \n character, while to expand "\0" (whole match) one needs the result of a match. Use check_replacement to find out whether string_to_expand contains references.

Parameters:

this

a MatchInfo or null

string_to_expand

the string to expand

Returns:

the expanded string, or null if an error occurred