59 lines
2.1 KiB
Groff
59 lines
2.1 KiB
Groff
'\"
|
|
'\" Copyright (c) 1989-1993 The Regents of the University of California.
|
|
'\" All rights reserved.
|
|
'\"
|
|
'\" Permission is hereby granted, without written agreement and without
|
|
'\" license or royalty fees, to use, copy, modify, and distribute this
|
|
'\" documentation for any purpose, provided that the above copyright
|
|
'\" notice and the following two paragraphs appear in all copies.
|
|
'\"
|
|
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
|
|
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
|
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
|
|
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
'\"
|
|
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
|
|
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
|
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
|
|
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
|
'\"
|
|
'\" $Header: /user6/ouster/tcl/man/RCS/Backslash.3,v 1.12 93/04/01 09:25:22 ouster Exp $ SPRITE (Berkeley)
|
|
'\"
|
|
.so man.macros
|
|
.HS Tcl_Backslash tclc
|
|
.BS
|
|
.SH NAME
|
|
Tcl_Backslash \- parse a backslash sequence
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <tcl.h>\fR
|
|
.sp
|
|
char
|
|
\fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
|
|
.SH ARGUMENTS
|
|
.AS char *countPtr
|
|
.AP char *src in
|
|
Pointer to a string starting with a backslash.
|
|
.AP int *countPtr out
|
|
If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
|
|
in with number of characters in the backslash sequence, including
|
|
the backslash character.
|
|
.BE
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
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.
|
|
\fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
|
|
of characters in the backslash sequence.
|
|
.PP
|
|
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 \fBTcl_Backslash\fR.
|
|
|
|
.SH KEYWORDS
|
|
backslash, parse
|