1PCRE_EXEC(3) Library Functions Manual PCRE_EXEC(3)
2
6 PCRE - Perl-compatible regular expressions
7
9 #include <pcre.h>
11 int pcre_exec(const pcre *code, const pcre_extra *extra,
13 const char *subject, int length, int startoffset,
14 int options, int *ovector, int ovecsize);
15 int pcre16_exec(const pcre16 *code, const pcre16_extra *extra,
17 PCRE_SPTR16 subject, int length, int startoffset,
18 int options, int *ovector, int ovecsize);
19 int pcre32_exec(const pcre32 *code, const pcre32_extra *extra,
21 PCRE_SPTR32 subject, int length, int startoffset,
22 int options, int *ovector, int ovecsize);
23
25 This function matches a compiled regular expression against a given
27 subject string, using a matching algorithm that is similar to Perl's.
28 It returns offsets to captured substrings. Its arguments are:
29 code Points to the compiled pattern
31 extra Points to an associated pcre[16|32]_extra structure,
32 or is NULL
33 subject Points to the subject string
34 length Length of the subject string, in bytes
35 startoffset Offset in bytes in the subject at which to
36 start matching
37 options Option bits
38 ovector Points to a vector of ints for result offsets
39 ovecsize Number of elements in the vector (a multiple of 3)
40 The options are:
42 PCRE_ANCHORED Match only at the first position
44 PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF
45 PCRE_BSR_UNICODE \R matches all Unicode line endings
46 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
47 PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences
48 PCRE_NEWLINE_CR Recognize CR as the only newline sequence
49 PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence
50 PCRE_NEWLINE_LF Recognize LF as the only newline sequence
51 PCRE_NOTBOL Subject string is not the beginning of a line
52 PCRE_NOTEOL Subject string is not the end of a line
53 PCRE_NOTEMPTY An empty string is not a valid match
54 PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject
55 is not a valid match
56 PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
57 PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16
58 validity (only relevant if PCRE_UTF16
59 was set at compile time)
60 PCRE_NO_UTF32_CHECK Do not check the subject for UTF-32
61 validity (only relevant if PCRE_UTF32
62 was set at compile time)
63 PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
64 validity (only relevant if PCRE_UTF8
65 was set at compile time)
66 PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial
67 PCRE_PARTIAL_SOFT ) match if no full matches are found
68 PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
69 if that is found before a full match
70 For details of partial matching, see the pcrepartial page. A pcre_extra
72 structure contains the following fields:
73 flags Bits indicating which fields are set
75 study_data Opaque data from pcre[16|32]_study()
76 match_limit Limit on internal resource use
77 match_limit_recursion Limit on internal recursion depth
78 callout_data Opaque data passed back to callouts
79 tables Points to character tables or is NULL
80 mark For passing back a *MARK pointer
81 executable_jit Opaque data from JIT compilation
82 The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
84 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
85 PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT.
86 There is a complete description of the PCRE native API in the pcreapi
88 page and a description of the POSIX API in the pcreposix page.
89PCRE 8.30 24 June 2012 PCRE_EXEC(3)