pcre2_get_startchar.3 936 B

1234567891011121314151617181920212223242526272829303132
  1. .TH PCRE2_GET_STARTCHAR 3 "24 October 2014" "PCRE2 10.00"
  2. .SH NAME
  3. PCRE2 - Perl-compatible regular expressions (revised API)
  4. .SH SYNOPSIS
  5. .rs
  6. .sp
  7. .B #include <pcre2.h>
  8. .PP
  9. .nf
  10. .B PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *\fImatch_data\fP);
  11. .fi
  12. .
  13. .SH DESCRIPTION
  14. .rs
  15. .sp
  16. After a successful call of \fBpcre2_match()\fP that was passed the match block
  17. that is this function's argument, this function returns the code unit offset of
  18. the character at which the successful match started. For a non-partial match,
  19. this can be different to the value of \fIovector[0]\fP if the pattern contains
  20. the \eK escape sequence. After a partial match, however, this value is always
  21. the same as \fIovector[0]\fP because \eK does not affect the result of a
  22. partial match.
  23. .P
  24. There is a complete description of the PCRE2 native API in the
  25. .\" HREF
  26. \fBpcre2api\fP
  27. .\"
  28. page and a description of the POSIX API in the
  29. .\" HREF
  30. \fBpcre2posix\fP
  31. .\"
  32. page.