/[pcre]/code/trunk/doc/pcreapi.3
ViewVC logotype

Diff of /code/trunk/doc/pcreapi.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 197 by ph10, Tue Jul 31 10:50:18 2007 UTC revision 211 by ph10, Thu Aug 9 09:52:43 2007 UTC
# Line 601  page. Line 601  page.
601    PCRE_NO_UTF8_CHECK    PCRE_NO_UTF8_CHECK
602  .sp  .sp
603  When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is  When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is
604  automatically checked. If an invalid UTF-8 sequence of bytes is found,  automatically checked. There is a discussion about the
605  \fBpcre_compile()\fP returns an error. If you already know that your pattern is  .\" HTML <a href="pcre.html#utf8strings">
606  valid, and you want to skip this check for performance reasons, you can set the  .\" </a>
607  PCRE_NO_UTF8_CHECK option. When it is set, the effect of passing an invalid  validity of UTF-8 strings
608  UTF-8 string as a pattern is undefined. It may cause your program to crash.  .\"
609  Note that this option can also be passed to \fBpcre_exec()\fP and  in the main
610  \fBpcre_dfa_exec()\fP, to suppress the UTF-8 validity checking of subject  .\" HREF
611  strings.  \fBpcre\fP
612    .\"
613    page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_compile()\fP
614    returns an error. If you already know that your pattern is valid, and you want
615    to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK
616    option. When it is set, the effect of passing an invalid UTF-8 string as a
617    pattern is undefined. It may cause your program to crash. Note that this option
618    can also be passed to \fBpcre_exec()\fP and \fBpcre_dfa_exec()\fP, to suppress
619    the UTF-8 validity checking of subject strings.
620  .  .
621  .  .
622  .SH "COMPILATION ERROR CODES"  .SH "COMPILATION ERROR CODES"
# Line 669  out of use. To avoid confusion, they hav Line 677  out of use. To avoid confusion, they hav
677    47  unknown property name after \eP or \ep    47  unknown property name after \eP or \ep
678    48  subpattern name is too long (maximum 32 characters)    48  subpattern name is too long (maximum 32 characters)
679    49  too many named subpatterns (maximum 10,000)    49  too many named subpatterns (maximum 10,000)
680    50  repeated subpattern is too long    50  [this code is not in use]
681    51  octal value is greater than \e377 (not in UTF-8 mode)    51  octal value is greater than \e377 (not in UTF-8 mode)
682    52  internal error: overran compiling workspace    52  internal error: overran compiling workspace
683    53  internal error: previously-checked referenced subpattern not found    53  internal error: previously-checked referenced subpattern not found
# Line 1232  code that demonstrates how to do this in Line 1240  code that demonstrates how to do this in
1240  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8  When PCRE_UTF8 is set at compile time, the validity of the subject as a UTF-8
1241  string is automatically checked when \fBpcre_exec()\fP is subsequently called.  string is automatically checked when \fBpcre_exec()\fP is subsequently called.
1242  The value of \fIstartoffset\fP is also checked to ensure that it points to the  The value of \fIstartoffset\fP is also checked to ensure that it points to the
1243  start of a UTF-8 character. If an invalid UTF-8 sequence of bytes is found,  start of a UTF-8 character. There is a discussion about the validity of UTF-8
1244  \fBpcre_exec()\fP returns the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP  strings in the
1245  contains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.  .\" HTML <a href="pcre.html#utf8strings">
1246    .\" </a>
1247    section on UTF-8 support
1248    .\"
1249    in the main
1250    .\" HREF
1251    \fBpcre\fP
1252    .\"
1253    page. If an invalid UTF-8 sequence of bytes is found, \fBpcre_exec()\fP returns
1254    the error PCRE_ERROR_BADUTF8. If \fIstartoffset\fP contains an invalid value,
1255    PCRE_ERROR_BADUTF8_OFFSET is returned.
1256  .P  .P
1257  If you already know that your subject is valid, and you want to skip these  If you already know that your subject is valid, and you want to skip these
1258  checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when  checks for performance reasons, you can set the PCRE_NO_UTF8_CHECK option when
# Line 1635  example is shown in the Line 1653  example is shown in the
1653  .\" HREF  .\" HREF
1654  \fBpcrepattern\fP  \fBpcrepattern\fP
1655  .\"  .\"
1656  documentation. When duplicates are present, \fBpcre_copy_named_substring()\fP  documentation.
1657  and \fBpcre_get_named_substring()\fP return the first substring corresponding  .P
1658  to the given name that is set. If none are set, an empty string is returned.  When duplicates are present, \fBpcre_copy_named_substring()\fP and
1659  The \fBpcre_get_stringnumber()\fP function returns one of the numbers that are  \fBpcre_get_named_substring()\fP return the first substring corresponding to
1660  associated with the name, but it is not defined which it is.  the given name that is set. If none are set, PCRE_ERROR_NOSUBSTRING (-7) is
1661  .sp  returned; no data is returned. The \fBpcre_get_stringnumber()\fP function
1662    returns one of the numbers that are associated with the name, but it is not
1663    defined which it is.
1664    .P
1665  If you want to get full details of all captured substrings for a given name,  If you want to get full details of all captured substrings for a given name,
1666  you must use the \fBpcre_get_stringtable_entries()\fP function. The first  you must use the \fBpcre_get_stringtable_entries()\fP function. The first
1667  argument is the compiled pattern, and the second is the name. The third and  argument is the compiled pattern, and the second is the name. The third and
# Line 1865  Cambridge CB2 3QH, England. Line 1886  Cambridge CB2 3QH, England.
1886  .rs  .rs
1887  .sp  .sp
1888  .nf  .nf
1889  Last updated: 30 July 2007  Last updated: 09 August 2007
1890  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2007 University of Cambridge.
1891  .fi  .fi

Legend:
Removed from v.197  
changed lines
  Added in v.211

  ViewVC Help
Powered by ViewVC 1.1.5