# pcre2_substring_length_bynumber man page

Return to the PCRE2 index page.

This page is part of the PCRE2 HTML documentation. It was generated automatically from the original man page. If there is any nonsense in it, please consult the man page, in case the conversion went wrong.
SYNOPSIS

#include <pcre2.h>

int pcre2_substring_length_bynumber(pcre2_match_data *match_data, unsigned int number, PCRE2_SIZE *length);

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
      number       The substring number
      length       Where to return the length

The yield is zero on success, or an error code if the substring is not found.

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.

Return to the PCRE2 index page.