summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15>2009-08-15 18:45:00 +0000
committerph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15>2009-08-15 18:45:00 +0000
commit0bd2cca21e2be39f156d5dfb07f0cfbc2ab9ae27 (patch)
tree4642323a6e349a8eaa27b19a97806b8ef38353ca
parent70701f1069a83f05f93edf88a04d9a1791fc1ccb (diff)
downloadpcre-0bd2cca21e2be39f156d5dfb07f0cfbc2ab9ae27.tar.gz
Add warning comment to pcreposix doc.
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@424 2f5784b3-3f2a-0410-8824-cb99058d5e15
-rw-r--r--doc/pcreposix.36
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/pcreposix.3 b/doc/pcreposix.3
index d63ac03..c5e5d7d 100644
--- a/doc/pcreposix.3
+++ b/doc/pcreposix.3
@@ -116,6 +116,10 @@ The yield of \fBregcomp()\fP is zero on success, and non-zero otherwise. The
\fIpreg\fP structure is filled in on success, and one member of the structure
is public: \fIre_nsub\fP contains the number of capturing subpatterns in
the regular expression. Various error codes are defined in the header file.
+.P
+NOTE: If the yield of \fBregcomp()\fP is non-zero, you must not attempt to
+use the contents of the \fIpreg\fP structure. If, for example, you pass it to
+\fBregexec()\fP, the result is undefined and your program is likely to crash.
.
.
.SH "MATCHING NEWLINE CHARACTERS"
@@ -239,6 +243,6 @@ Cambridge CB2 3QH, England.
.rs
.sp
.nf
-Last updated: 11 March 2009
+Last updated: 15 August 2009
Copyright (c) 1997-2009 University of Cambridge.
.fi