summaryrefslogtreecommitdiff
path: root/doc/html/pcre2_pattern_info.html
diff options
context:
space:
mode:
authorph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2014-12-01 16:14:53 +0000
committerph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2014-12-01 16:14:53 +0000
commit9da47480045c6cc9fc49cd2752b0fa520a58287c (patch)
tree95ad4b536269f02421242755e8b48b11c6aeb3ad /doc/html/pcre2_pattern_info.html
parent08de510bcf169f076c481ffa4e274ff5c0480c68 (diff)
downloadpcre2-9da47480045c6cc9fc49cd2752b0fa520a58287c.tar.gz
(1) uint32_t for substring number args; (2) correct PRIV(memctl_malloc)
definition for Windows; (3) remove unwanted PCRE2_EXP_DATA_DEFN; (4) documentation updates. git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@171 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/html/pcre2_pattern_info.html')
-rw-r--r--doc/html/pcre2_pattern_info.html35
1 files changed, 19 insertions, 16 deletions
diff --git a/doc/html/pcre2_pattern_info.html b/doc/html/pcre2_pattern_info.html
index 6aae36e..4e007ee 100644
--- a/doc/html/pcre2_pattern_info.html
+++ b/doc/html/pcre2_pattern_info.html
@@ -27,19 +27,19 @@ DESCRIPTION
<P>
This function returns information about a compiled pattern. Its arguments are:
<pre>
- <i>code</i> Compiled regular expression
- <i>what</i> What information is required
- <i>where</i> Where to put the information
+ <i>code</i> Pointer to a compiled regular expression
+ <i>what</i> What information is required
+ <i>where</i> Where to put the information
</pre>
-If <i>where</i> is NULL, the function returns the amount of memory needed for
-the requested information, in bytes. The following information is available:
+The recognized values for the <i>what</i> argument, and the information they
+request are as follows:
<pre>
PCRE2_INFO_ALLOPTIONS Final options after compiling
PCRE2_INFO_ARGOPTIONS Options passed to <b>pcre2_compile()</b>
PCRE2_INFO_BACKREFMAX Number of highest back reference
- PCRE2_INFO_BSR What \R matches
- 0 all Unicode line endings
- 1 CR, LF, or CRLF only
+ PCRE2_INFO_BSR What \R matches:
+ PCRE2_BSR_UNICODE: Unicode line endings
+ PCRE2_BSR_ANYCRLF: CR, LF, or CRLF only
PCRE2_INFO_CAPTURECOUNT Number of capturing subpatterns
PCRE2_INFO_FIRSTBITMAP Bitmap of first code units, or NULL
PCRE2_INFO_FIRSTCODEUNIT First code unit when type is 1
@@ -58,7 +58,7 @@ the requested information, in bytes. The following information is available:
PCRE2_INFO_MATCHEMPTY 1 if the pattern can match an
empty string, 0 otherwise
PCRE2_INFO_MATCHLIMIT Match limit if set,
- otherwise PCRE2_RROR_UNSET
+ otherwise PCRE2_ERROR_UNSET
PCRE2_INFO_MAXLOOKBEHIND Length (in characters) of the longest
lookbehind assertion
PCRE2_INFO_MINLENGTH Lower bound length of matching strings
@@ -66,17 +66,20 @@ the requested information, in bytes. The following information is available:
PCRE2_INFO_NAMECOUNT Number of named subpatterns
PCRE2_INFO_NAMETABLE Pointer to name table
PCRE2_CONFIG_NEWLINE Code for the newline sequence:
- 1 for CR
- 2 for LF
- 3 for CRLF
- 4 for ANY
- 5 for ANYCRLF
+ PCRE2_NEWLINE_CR
+ PCRE2_NEWLINE_LF
+ PCRE2_NEWLINE_CRLF
+ PCRE2_NEWLINE_ANY
+ PCRE2_NEWLINE_ANYCRLF
PCRE2_INFO_RECURSIONLIMIT Recursion limit if set,
otherwise PCRE2_ERROR_UNSET
PCRE2_INFO_SIZE Size of compiled pattern
</pre>
-The <i>where</i> argument must point to an unsigned 32-bit integer (uint32_t
-variable), except for the following <i>what</i> values:
+If <i>where</i> is NULL, the function returns the amount of memory needed for
+the requested information, in bytes. Otherwise, the <i>where</i> argument must
+point to an unsigned 32-bit integer (uint32_t variable), except for the
+following <i>what</i> values, when it must point to a variable of the type
+shown:
<pre>
PCRE2_INFO_FIRSTBITMAP const uint8_t *
PCRE2_INFO_JITSIZE size_t