home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 0 / 0998 / Backslash.3 next >
Text File  |  1990-12-28  |  2KB  |  51 lines
  1. '\" Copyright 1989 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/lib/tcl/RCS/Tcl_Backslash.man,v 1.4 89/05/18 16:29:01 ouster Exp $ SPRITE (Berkeley)
  10. '\" 
  11. .so \*(]ltmac.sprite
  12. .HS Tcl_Backslash tcl
  13. .BS
  14. .SH NAME
  15. Tcl_Backslash \- parse a backslash sequence
  16. .SH SYNOPSIS
  17. .nf
  18. \fB#include <tcl.h>\fR
  19. .sp
  20. char
  21. \fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
  22. .SH ARGUMENTS
  23. .AP char *src in
  24. Pointer to a string starting with a backslash.
  25. .AP int *countPtr out
  26. If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
  27. in with number of characters in the backslash sequence, including
  28. the backslash character.
  29. .BE
  30.  
  31. .SH DESCRIPTION
  32. .PP
  33. This is a utility procedure used by several of the Tcl
  34. commands.  It parses a backslash sequence and returns
  35. the single character corresponding to the sequence.
  36. \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number of characters in
  37. the backslash sequence.  If \fIsrc\fR doesn't point to a backslash
  38. sequence understood by Tcl, then Tcl_Backslash returns a backslash
  39. as its result and \fI*countPtr\fR gets set to 1 (in this case the
  40. backslash character should not get any special treatment).
  41. .PP
  42. See the Tcl manual entry for information on the valid
  43. backslash sequences.  All of the sequences described in the Tcl
  44. .VS
  45. manual entry are supported by \fBTcl_Backslash\fR except
  46. backslash-newline, which is not understood.
  47. .VE
  48.  
  49. .SH KEYWORDS
  50. backslash, parse
  51.