Tcl_Backslash(3)

Tcl_Backslash(3)

Tcl_BackgroundError Home Page Subroutines Index Tcl_BadChannelOption


_________________________________________________________________

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.  Tcl_Back-
       slash  modifies *countPtr to contain the number of charac-
       ters 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.

KEYWORDS
       backslash, parse

Tcl_BackgroundError Home Page Subroutines Index Tcl_BadChannelOption