Copyright (c) 1989-1993 The Regents of the University of California.
Copyright (c) 1994-1996 Sun Microsystems, Inc.

See the file "license.terms" for information on usage and redistribution
of this file, and for a DISCLAIMER OF ALL WARRANTIES.

RCS: @(#) $Id: Backslash.3,v 1.10 2007/12/13 15:22:30 dgp Exp $

.so man.macros S Tcl_Backslash - parse a backslash sequence

#include <tcl.h>
char
Tcl_Backslash(src, countPtr)
 ARGUMENTS
.AS char *countPtr out
.AP char *src in
Pointer to a string starting with a backslash.
.AP int *countPtr out
If countPtr is not NULL, *countPtr gets filled
in with number of characters in the backslash sequence, including
the backslash character.
E 
 DESCRIPTION

The use of Tcl_Backslash is deprecated in favor of
Tcl_UtfBackslash.

This is a utility procedure provided for backwards compatibility with
non-internationalized Tcl extensions. It parses a backslash sequence and
returns the low byte of the Unicode character corresponding to the sequence. 
Tcl_Backslash modifies *countPtr to contain the number of
characters in the backslash sequence.

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.
 "SEE ALSO"
Tcl(n), Tcl_UtfBackslash(3)

 KEYWORDS
backslash, parse