| Line | |
|---|
| 1 | '\" |
|---|
| 2 | '\" Copyright (c) 1989-1993 The Regents of the University of California. |
|---|
| 3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
|---|
| 4 | '\" |
|---|
| 5 | '\" See the file "license.terms" for information on usage and redistribution |
|---|
| 6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
|---|
| 7 | '\" |
|---|
| 8 | '\" RCS: @(#) $Id: Backslash.3,v 1.10 2007/12/13 15:22:30 dgp Exp $ |
|---|
| 9 | '\" |
|---|
| 10 | .so man.macros |
|---|
| 11 | .TH Tcl_Backslash 3 "8.1" Tcl "Tcl Library Procedures" |
|---|
| 12 | .BS |
|---|
| 13 | .SH NAME |
|---|
| 14 | Tcl_Backslash \- parse a backslash sequence |
|---|
| 15 | .SH SYNOPSIS |
|---|
| 16 | .nf |
|---|
| 17 | \fB#include <tcl.h>\fR |
|---|
| 18 | .sp |
|---|
| 19 | char |
|---|
| 20 | \fBTcl_Backslash\fR(\fIsrc, countPtr\fR) |
|---|
| 21 | .SH ARGUMENTS |
|---|
| 22 | .AS char *countPtr out |
|---|
| 23 | .AP char *src in |
|---|
| 24 | Pointer to a string starting with a backslash. |
|---|
| 25 | .AP int *countPtr out |
|---|
| 26 | If \fIcountPtr\fR is not NULL, \fI*countPtr\fR gets filled |
|---|
| 27 | in with number of characters in the backslash sequence, including |
|---|
| 28 | the backslash character. |
|---|
| 29 | .BE |
|---|
| 30 | |
|---|
| 31 | .SH DESCRIPTION |
|---|
| 32 | .PP |
|---|
| 33 | The use of \fBTcl_Backslash\fR is deprecated in favor of |
|---|
| 34 | \fBTcl_UtfBackslash\fR. |
|---|
| 35 | .PP |
|---|
| 36 | This is a utility procedure provided for backwards compatibility with |
|---|
| 37 | non-internationalized Tcl extensions. It parses a backslash sequence and |
|---|
| 38 | returns the low byte of the Unicode character corresponding to the sequence. |
|---|
| 39 | \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number of |
|---|
| 40 | characters in the backslash sequence. |
|---|
| 41 | .PP |
|---|
| 42 | See the Tcl manual entry for information on the valid backslash sequences. |
|---|
| 43 | All of the sequences described in the Tcl manual entry are supported by |
|---|
| 44 | \fBTcl_Backslash\fR. |
|---|
| 45 | .SH "SEE ALSO" |
|---|
| 46 | Tcl(n), Tcl_UtfBackslash(3) |
|---|
| 47 | |
|---|
| 48 | .SH KEYWORDS |
|---|
| 49 | backslash, parse |
|---|
Note: See
TracBrowser
for help on using the repository browser.
