summaryrefslogtreecommitdiff
path: root/doc/pcre2_substring_number_from_name.3
diff options
context:
space:
mode:
authorph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2014-10-31 12:34:34 +0000
committerph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2014-10-31 12:34:34 +0000
commitd3882ead437dfbb19d4c820969bdf3e3b295e4aa (patch)
treea443cac581d4bc2937460040039e59fdd7cb2975 /doc/pcre2_substring_number_from_name.3
parent3c72e5dc813861511562b11663765a66953f2ce5 (diff)
downloadpcre2-d3882ead437dfbb19d4c820969bdf3e3b295e4aa.tar.gz
Improve test coverage; minor typo in JIT test and other minor buglets fixed.
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@128 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/pcre2_substring_number_from_name.3')
-rw-r--r--doc/pcre2_substring_number_from_name.311
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/pcre2_substring_number_from_name.3 b/doc/pcre2_substring_number_from_name.3
index d6588bc..12a9d3d 100644
--- a/doc/pcre2_substring_number_from_name.3
+++ b/doc/pcre2_substring_number_from_name.3
@@ -15,16 +15,17 @@ PCRE2 - Perl-compatible regular expressions (revised API)
.rs
.sp
This convenience function finds the number of a named substring capturing
-parenthesis in a compiled pattern. Its arguments are:
+parenthesis in a compiled pattern, provided that it is a unique name. The
+function arguments are:
.sp
\fIcode\fP Compiled regular expression
\fIname\fP Name whose number is required
.sp
The yield of the function is the number of the parenthesis if the name is
-found, or PCRE2_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
-(PCRE2_DUPNAMES is set), it is not defined which of the numbers is returned.
-You can obtain the complete list by calling
-\fBpcre2_substring_nametable_scan()\fP.
+found, or PCRE2_ERROR_NOSUBSTRING if it is not found. When duplicate names are
+allowed (PCRE2_DUPNAMES is set), if the name is not unique,
+PCRE2_ERROR_NOUNIQUESUBSTRING is returned. You can obtain the list of numbers
+with the same name by calling \fBpcre2_substring_nametable_scan()\fP.
.P
There is a complete description of the PCRE2 native API in the
.\" HREF