pcre2_set_offset_limit

PCRE2 10.50-DEV manual; updated

Synopsis

#include <pcre2.h>

int pcre2_set_offset_limit(pcre2_match_context *mcontext,
                           PCRE2_SIZE limit);

Description

This function sets the offset limit field in a match context. The result is always zero. The largest value a PCRE2_SIZE variable can hold removes the offset limit.

Any other value must not exceed the subject length when matching. pcre2_match() and pcre2_dfa_match() return PCRE2_ERROR_BADOFFSETLIMITVALUE if it does. The setter cannot check this condition because it does not receive the subject.

There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the pcre2posix page.