NAME
Tcl_Backslash - parse a backslash sequence
SYNOPSIS
#include <tcl.h>
char
Tcl_Backslash(src, countPtr)
ARGUMENTS
-
char *src (in)
-
Pointer to a string starting with a backslash.
-
int *countPtr (out)
-
If countPtr isn't NULL, *countPtr gets filled
in with number of characters in the backslash sequence, including
the backslash character.
DESCRIPTION
This is a utility procedure used by several of the Tcl
commands. It parses a backslash sequence and returns
the single character corresponding to the sequence.
If the backslash sequence should be replaced by no character
at all (e.g. backslash-newline) then Tcl_Backslash returns 0.
Tcl_Backslash modifies *countPtr to contain the number
of characters in the backslash sequence.
If src doesn't point to a backslash
sequence understood by Tcl, then Tcl_Backslash returns a backslash
as its result and *countPtr gets set to 1 (in this case the
backslash character should not get any special treatment).
See the Tcl manual entry for information on the valid
backslash sequences.
All of the sequences described in the Tcl
manual entry are supported by Tcl_Backslash.
KEYWORDS
backslash, parse
[ tinytcl ]
Copyright © 1989-1994 The Regents of the University of California.
Copyright © 1994-1996 Sun Microsystems, Inc.
