home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / RegExp.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  2.5 KB  |  65 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/RegExp.3,v 1.1 93/05/05 17:06:04 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) RegExp.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_RegExpMatch tclc 7.0
  32. .BS
  33. .SH NAME
  34. Tcl_RegExpMatch \- Test whether a string matches a regular expression
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. int
  40. \fBTcl_RegExpMatch\fR(\fIinterp\fR, \fIstring\fR, \fIregexp\fR)
  41. .SH ARGUMENTS
  42. .AS Tcl_Interp *interp
  43. .AP Tcl_Interp *interp in
  44. Tcl interpreter to use for error reporting.
  45. .AP char *string in
  46. String to test.
  47. .AP char *regexp in
  48. Regular expression to match against \fIstring\fR.
  49. .BE
  50.  
  51. .SH DESCRIPTION
  52. .PP
  53. \fBTcl_RegExpMatch\fR determines whether its \fIstring\fR argument
  54. matches \fIregexp\fR, where \fIregexp\fR is interpreted
  55. as a regular expression using the same rules as for the
  56. \fBregexp\fR Tcl command.
  57. If there is a match then \fBTcl_RegExpMatch\fR returns 1.
  58. If there is no match then \fBTcl_RegExpMatch\fR returns 0.
  59. If an error occurs in the matching process (e.g. \fIregexp\fR
  60. is not a valid regular expression) then \fBTcl_RegExpMatch\fR
  61. returns \-1 and leaves an error message in \fIinterp->result\fR.
  62.  
  63. .SH KEYWORDS
  64. match, regular expression, string
  65.