summaryrefslogtreecommitdiffstats
path: root/doc/RegExp.3
diff options
context:
space:
mode:
authorericm <ericm>2000-06-19 21:34:45 (GMT)
committerericm <ericm>2000-06-19 21:34:45 (GMT)
commit3eb9179c354793e398482a1a00b12e7c3ef645b9 (patch)
tree40d4f2ca318046590b8ada7f5cae3eb5d53a8d35 /doc/RegExp.3
parent8bb9bc448fdea2fd557b000733dda032dbc90067 (diff)
downloadtcl-3eb9179c354793e398482a1a00b12e7c3ef645b9.zip
tcl-3eb9179c354793e398482a1a00b12e7c3ef645b9.tar.gz
tcl-3eb9179c354793e398482a1a00b12e7c3ef645b9.tar.bz2
* doc/RegExp.3: Replaced instances of "Tcl_GetRegExpInfo" with
"Tcl_RegExpGetInfo", the correct name of the function [Bug: 5901].
Diffstat (limited to 'doc/RegExp.3')
-rw-r--r--doc/RegExp.316
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/RegExp.3 b/doc/RegExp.3
index 8dbdfe4..425b96f 100644
--- a/doc/RegExp.3
+++ b/doc/RegExp.3
@@ -6,13 +6,13 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: RegExp.3,v 1.6 1999/12/21 23:57:33 hobbs Exp $
+'\" RCS: @(#) $Id: RegExp.3,v 1.7 2000/06/19 21:34:46 ericm Exp $
'\"
.so man.macros
.TH Tcl_RegExpMatch 3 8.1 Tcl "Tcl Library Procedures"
.BS
.SH NAME
-Tcl_RegExpMatch, Tcl_RegExpCompile, Tcl_RegExpExec, Tcl_RegExpRange, Tcl_GetRegExpFromObj, Tcl_RegExpMatchObj, Tcl_GetRegExpInfo \- Pattern matching with regular expressions
+Tcl_RegExpMatch, Tcl_RegExpCompile, Tcl_RegExpExec, Tcl_RegExpRange, Tcl_GetRegExpFromObj, Tcl_RegExpMatchObj, Tcl_RegExpGetInfo \- Pattern matching with regular expressions
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
@@ -38,7 +38,7 @@ Tcl_RegExp
int
\fBTcl_RegExpExecObj\fR(\fIinterp\fR, \fIregexp\fR, \fIobjPtr\fR, \fIoffset\fR, \fInmatches\fR, \fIeflags\fR)
.sp
-\fBTcl_GetRegExpInfo\fR(\fIregexp\fR, \fIinfoPtr\fR)
+\fBTcl_RegExpGetInfo\fR(\fIregexp\fR, \fIinfoPtr\fR)
.VE 8.1
.SH ARGUMENTS
@@ -99,7 +99,7 @@ OR-ed combination of the values TCL_REG_NOTBOL and TCL_REG_NOTEOL.
See below for more information.
.AP Tcl_RegExpInfo *infoPtr out
The address of the location where information about a previous match
-should be stored by \fBTcl_GetRegExpInfo\fR.
+should be stored by \fBTcl_RegExpGetInfo\fR.
.VE 8.1
.BE
@@ -170,7 +170,7 @@ is stored in \fI*firstPtr\fR and \fI*lastPtr\fR.
.PP
.VS 8.1
\fBTcl_GetRegExpFromObj\fR, \fBTcl_RegExpExecObj\fR, and
-\fBTcl_GetRegExpInfo\fR are object interfaces that provide the most
+\fBTcl_RegExpGetInfo\fR are object interfaces that provide the most
direct control of Henry Spencer's regular expression library. For
users that need to modify compilation and execution options directly,
it is recommended that you use these interfaces instead of calling the
@@ -185,7 +185,7 @@ from the string in the object and assign it to the internal
representation of the \fIpatObj\fR. The return value of this function
is of type \fBTcl_RegExp\fR. The return value is a token for this
compiled form, which can be used in subsequent calls to
-\fBTcl_RegExpExecObj\fR or \fBTcl_GetRegExpInfo\fR. If an error
+\fBTcl_RegExpExecObj\fR or \fBTcl_RegExpGetInfo\fR. If an error
occurs while compiling the regular expression then
\fBTcl_GetRegExpFromObj\fR returns NULL and leaves an error message in
the interpreter result. The regular expression token can be used as
@@ -251,7 +251,7 @@ an empty string before any newline in addition to its normal function.
\fBTCL_REG_NOSUB\fR
Compile for matching that reports only success or failure,
not what was matched. This reduces compile overhead and may improve
-performance. Subsequent calls to \fBTcl_GetRegExpInfo\fR or
+performance. Subsequent calls to \fBTcl_RegExpGetInfo\fR or
\fBTcl_RegExpRange\fR will not report any match information.
.TP
\fBTCL_REG_CANMATCH\fR
@@ -294,7 +294,7 @@ line or the end of the string, so '$' will not match there.
Note that this flag has no effect on how `\fB\eZ\fR' matches.
.RE
.PP
-\fBTcl_GetRegExpInfo\fR retrieves information about the last match
+\fBTcl_RegExpGetInfo\fR retrieves information about the last match
performed with a given regular expression \fIregexp\fR. The
\fIinfoPtr\fR argument contains a pointer to a structure that is
defined as follows: