home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / Backslash.3 < prev    next >
Text File  |  1993-04-01  |  2KB  |  59 lines
  1. '\"
  2. '\" Copyright (c) 1989-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/Backslash.3,v 1.12 93/04/01 09:25:22 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tcl_Backslash tclc
  25. .BS
  26. .SH NAME
  27. Tcl_Backslash \- parse a backslash sequence
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tcl.h>\fR
  31. .sp
  32. char
  33. \fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
  34. .SH ARGUMENTS
  35. .AS char *countPtr
  36. .AP char *src in
  37. Pointer to a string starting with a backslash.
  38. .AP int *countPtr out
  39. If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
  40. in with number of characters in the backslash sequence, including
  41. the backslash character.
  42. .BE
  43.  
  44. .SH DESCRIPTION
  45. .PP
  46. This is a utility procedure used by several of the Tcl
  47. commands.  It parses a backslash sequence and returns
  48. the single character corresponding to the sequence.
  49. \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
  50. of characters in the backslash sequence.
  51. .PP
  52. See the Tcl manual entry for information on the valid
  53. backslash sequences.
  54. All of the sequences described in the Tcl
  55. manual entry are supported by \fBTcl_Backslash\fR.
  56.  
  57. .SH KEYWORDS
  58. backslash, parse
  59.