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

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc / html / pcre_exec.html
Revision 1.1.1.2 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Tue Feb 21 23:50:25 2012 UTC (12 years, 5 months ago) by misho
Branches: pcre, MAIN
CVS tags: v8_31, v8_30, HEAD

pcre

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: DESCRIPTION 33:   34:  35: This function matches a compiled regular expression against a given subject 36: string, using a matching algorithm that is similar to Perl's. It returns 37: offsets to captured substrings. Its arguments are: 38: <pre> 39: code Points to the compiled pattern 40: extra Points to an associated pcre[16]_extra structure, 41: or is NULL 42: subject Points to the subject string 43: length Length of the subject string, in bytes 44: startoffset Offset in bytes in the subject at which to 45: start matching 46: options Option bits 47: ovector Points to a vector of ints for result offsets 48: ovecsize Number of elements in the vector (a multiple of 3) 49: </pre> 50: The options are: 51: <pre> 52: PCRE_ANCHORED Match only at the first position 53: PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF 54: PCRE_BSR_UNICODE \R matches all Unicode line endings 55: PCRE_NEWLINE_ANY Recognize any Unicode newline sequence 56: PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences 57: PCRE_NEWLINE_CR Recognize CR as the only newline sequence 58: PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence 59: PCRE_NEWLINE_LF Recognize LF as the only newline sequence 60: PCRE_NOTBOL Subject string is not the beginning of a line 61: PCRE_NOTEOL Subject string is not the end of a line 62: PCRE_NOTEMPTY An empty string is not a valid match 63: PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject 64: is not a valid match 65: PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations 66: PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16 67: validity (only relevant if PCRE_UTF16 68: was set at compile time) 69: PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 70: validity (only relevant if PCRE_UTF8 71: was set at compile time) 72: PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial 73: PCRE_PARTIAL_SOFT ) match if no full matches are found 74: PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match 75: if that is found before a full match 76: </pre> 77: For details of partial matching, see the 78: <a href="pcrepartial.html">pcrepartial</a> 79: page. A pcre_extra structure contains the following fields: 80: <pre> 81: flags Bits indicating which fields are set 82: study_data Opaque data from pcre[16]_study() 83: match_limit Limit on internal resource use 84: match_limit_recursion Limit on internal recursion depth 85: callout_data Opaque data passed back to callouts 86: tables Points to character tables or is NULL 87: mark For passing back a *MARK pointer 88: executable_jit Opaque data from JIT compilation 89: </pre> 90: The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT, 91: PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, 92: PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT. 93: 94: 95: There is a complete description of the PCRE native API in the 96: <a href="pcreapi.html">pcreapi</a> 97: page and a description of the POSIX API in the 98: <a href="pcreposix.html">pcreposix</a> 99: page. 100: 101: Return to the <a href="index.html">PCRE index page</a>. 102: 103: