Study
Prev Chapter 11. Regular Expression Methods from RegexSupport.g Next

Study

Study — helpful for speeding up repeated applications of a regular expression.

Synopsis

Regex.Study(options?=0)

Arguments

options

Must be zero in this implementation.

Returns

On success, an instance of pcre_extra. On failure, an error list with three elements:

  • car(errlist) = a numeric return code from the failing function

  • cadr(errlist) = a character position in the pattern where the error occurred, or 0.

  • caddr(errlist) = an error message, as a human-readable string

Description

This method evaluates a regular expression to produce hints that can speed up the application of the regular expression in future. This method does not need to be called, but is useful to speed up repeated application of the same regular epxression.

See Also

Match

Prev Up Next
Match Home Subst