Tcl_Backslash()

parse a backslash sequence 

Tcl Library Procedures

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

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 reference page for information on the valid backslash sequences. All of the sequences described in the Tcl reference page are supported by Tcl_Backslash().

PORTABILITY

Windows 8.1. Windows Server 2012 R2. Windows 10. Windows Server 2016. Windows Server 2019. Windows 11. Windows Server 2022.

AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition

SEE ALSO

Commands:
Tcl

Functions:
Tcl_UtfBackslash()

PTC MKS Toolkit 10.4 Documentation Build 39.