Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tcl_Backslash (3tcl)

Name

Tcl_Backslash - parse a backslash sequence

Synopsis

#include <tcl.h>

char
Tcl_Backslash(src, countPtr)

Description

Tcl_Backslash(3tcl)         Tcl Library Procedures         Tcl_Backslash(3tcl)



______________________________________________________________________________

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 back-
                                    slash.

       int *countPtr (out)          If countPtr is not  NULL,  *countPtr  gets
                                    filled in with number of characters in the
                                    backslash sequence,  including  the  back-
                                    slash character.
______________________________________________________________________________


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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tcl-8    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       Tcl(n), Tcl_UtfBackslash(3)


KEYWORDS
       backslash, parse



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source was downloaded from  http://prdownloads.sourceforge.net/tcl/tcl-
       core8.6.7-src.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tcl                                   8.1                  Tcl_Backslash(3tcl)