2 '\" Copyright (c) 1989-1993 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: GetInt.3,v 1.4 2001/09/25 16:23:55 dgp Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures"
249 Tcl_GetInt, Tcl_GetDouble, Tcl_GetBoolean \- convert from string to integer, double, or boolean
252 \fB#include <tcl.h>\fR
255 \fBTcl_GetInt\fR(\fIinterp, string, intPtr\fR)
258 \fBTcl_GetDouble\fR(\fIinterp, string, doublePtr\fR)
261 \fBTcl_GetBoolean\fR(\fIinterp, string, boolPtr\fR)
263 .AS Tcl_Interp *doublePtr
264 .AP Tcl_Interp *interp in
265 Interpreter to use for error reporting.
266 .AP "CONST char" *string in
267 Textual value to be converted.
269 Points to place to store integer value converted from \fIstring\fR.
270 .AP double *doublePtr out
271 Points to place to store double-precision floating-point
272 value converted from \fIstring\fR.
274 Points to place to store boolean value (0 or 1) converted from \fIstring\fR.
279 These procedures convert from strings to integers or double-precision
280 floating-point values or booleans (represented as 0- or 1-valued
281 integers). Each of the procedures takes a \fIstring\fR argument,
282 converts it to an internal form of a particular type, and stores
283 the converted value at the location indicated by the procedure's
284 third argument. If all goes well, each of the procedures returns
285 TCL_OK. If \fIstring\fR doesn't have the proper syntax for the
286 desired type then TCL_ERROR is returned, an error message is left
287 in the interpreter's result, and nothing is stored at *\fIintPtr\fR
288 or *\fIdoublePtr\fR or *\fIboolPtr\fR.
290 \fBTcl_GetInt\fR expects \fIstring\fR to consist of a collection
291 of integer digits, optionally signed and optionally preceded by
292 white space. If the first two characters of \fIstring\fR are ``0x''
293 then \fIstring\fR is expected to be in hexadecimal form; otherwise,
294 if the first character of \fIstring\fR is ``0'' then \fIstring\fR
295 is expected to be in octal form; otherwise, \fIstring\fR is
296 expected to be in decimal form.
298 \fBTcl_GetDouble\fR expects \fIstring\fR to consist of a floating-point
299 number, which is: white space; a sign; a sequence of digits; a
300 decimal point; a sequence of digits; the letter ``e''; and a
301 signed decimal exponent. Any of the fields may be omitted, except that
302 the digits either before or after the decimal point must be present
303 and if the ``e'' is present then it must be followed by the
306 \fBTcl_GetBoolean\fR expects \fIstring\fR to specify a boolean
307 value. If \fIstring\fR is any of \fB0\fR, \fBfalse\fR,
308 \fBno\fR, or \fBoff\fR, then \fBTcl_GetBoolean\fR stores a zero
309 value at \fI*boolPtr\fR.
310 If \fIstring\fR is any of \fB1\fR, \fBtrue\fR, \fByes\fR, or \fBon\fR,
311 then 1 is stored at \fI*boolPtr\fR.
312 Any of these values may be abbreviated, and upper-case spellings
316 boolean, conversion, double, floating-point, integer