pcre2_substring_length_bynumber

Manual page for PCRE2 10.50-DEV

Name

pcre2_substring_length_bynumber - find length of numbered substring

Synopsis

#include <pcre2.h>

int pcre2_substring_length_bynumber(pcre2_match_data *match_data,
                                    uint32_t stringnumber,
                                    PCRE2_SIZE *sizeptr);

Description

This function returns the length of a matched substring, identified by number. The arguments are:

match_data

The match data block for the match

stringnumber

The substring number

sizeptr

Where to return the length, or NULL

The third argument may be NULL if all you want to know is whether or not a substring is set. The yield is zero on success, or a negative error code otherwise. After a partial match, only substring 0 is available.

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.