embedaddon/pcre/doc/html/pcre_exec.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc / html / pcre_exec.html
Revision 1.1.1.3 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Mon Jul 22 08:25:57 2013 UTC (11 years ago) by misho
Branches: pcre, MAIN
CVS tags: v8_33, HEAD

8.33

1: <html> 2: <head> 3: <title>pcre_exec specification</title> 4: </head> 5: <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6: <h1>pcre_exec man page</h1> 7:  8: Return to the <a href="index.html">PCRE index page</a>. 9:  10:  11: This page is part of the PCRE HTML documentation. It was generated automatically 12: from the original man page. If there is any nonsense in it, please consult the 13: man page, in case the conversion went wrong. 14:   15:   16: SYNOPSIS 17:   18:  19: #include <pcre.h> 20:  21:  22: int pcre_exec(const pcre *code, const pcre_extra *extra, 23: const char *subject, int length, int startoffset, 24: int options, int *ovector, int ovecsize); 25:  26:  27: int pcre16_exec(const pcre16 *code, const pcre16_extra *extra, 28: PCRE_SPTR16 subject, int length, int startoffset, 29: int options, int *ovector, int ovecsize); 30:  31:  32: int pcre32_exec(const pcre32 *code, const pcre32_extra *extra, 33: PCRE_SPTR32 subject, int length, int startoffset, 34: int options, int *ovector, int ovecsize); 35:  36:   37: DESCRIPTION 38:   39:  40: This function matches a compiled regular expression against a given subject 41: string, using a matching algorithm that is similar to Perl's. It returns 42: offsets to captured substrings. Its arguments are: 43: <pre> 44: code Points to the compiled pattern 45: extra Points to an associated pcre[16|32]_extra structure, 46: or is NULL 47: subject Points to the subject string 48: length Length of the subject string 49: startoffset Offset in the subject at which to start matching 50: options Option bits 51: ovector Points to a vector of ints for result offsets 52: ovecsize Number of elements in the vector (a multiple of 3) 53: </pre> 54: The units for length and startoffset are bytes for 55: pcre_exec(), 16-bit data items for pcre16_exec(), and 32-bit items 56: for pcre32_exec(). The options are: 57: <pre> 58: PCRE_ANCHORED Match only at the first position 59: PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF 60: PCRE_BSR_UNICODE \R matches all Unicode line endings 61: PCRE_NEWLINE_ANY Recognize any Unicode newline sequence 62: PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences 63: PCRE_NEWLINE_CR Recognize CR as the only newline sequence 64: PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence 65: PCRE_NEWLINE_LF Recognize LF as the only newline sequence 66: PCRE_NOTBOL Subject string is not the beginning of a line 67: PCRE_NOTEOL Subject string is not the end of a line 68: PCRE_NOTEMPTY An empty string is not a valid match 69: PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject 70: is not a valid match 71: PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations 72: PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16 73: validity (only relevant if PCRE_UTF16 74: was set at compile time) 75: PCRE_NO_UTF32_CHECK Do not check the subject for UTF-32 76: validity (only relevant if PCRE_UTF32 77: was set at compile time) 78: PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 79: validity (only relevant if PCRE_UTF8 80: was set at compile time) 81: PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial 82: PCRE_PARTIAL_SOFT ) match if no full matches are found 83: PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match 84: if that is found before a full match 85: </pre> 86: For details of partial matching, see the 87: <a href="pcrepartial.html">pcrepartial</a> 88: page. A pcre_extra structure contains the following fields: 89: <pre> 90: flags Bits indicating which fields are set 91: study_data Opaque data from pcre[16|32]_study() 92: match_limit Limit on internal resource use 93: match_limit_recursion Limit on internal recursion depth 94: callout_data Opaque data passed back to callouts 95: tables Points to character tables or is NULL 96: mark For passing back a *MARK pointer 97: executable_jit Opaque data from JIT compilation 98: </pre> 99: The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT, 100: PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, 101: PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT. 102: 103: 104: There is a complete description of the PCRE native API in the 105: <a href="pcreapi.html">pcreapi</a> 106: page and a description of the POSIX API in the 107: <a href="pcreposix.html">pcreposix</a> 108: page. 109: 110: Return to the <a href="index.html">PCRE index page</a>. 111: 112: