Seth Woolley's Man Viewer

Tcl_GetBoolean(3) - Tcl_GetBoolean, Tcl_GetDouble, Tcl_GetInt - convert from string to integer, double, or boolean - man 3 Tcl_GetBoolean

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

Tcl_GetInt(3)               Tcl Library Procedures               Tcl_GetInt(3)



______________________________________________________________________________

NAME
       Tcl_GetInt,  Tcl_GetDouble,  Tcl_GetBoolean  -  convert  from string(3,n) to
       integer, double, or boolean

SYNOPSIS
       #include <tcl.h>

       int
       Tcl_GetInt(interp, string(3,n), intPtr)

       int
       Tcl_GetDouble(interp, string(3,n), doublePtr)

       int
       Tcl_GetBoolean(interp, string(3,n), boolPtr)

ARGUMENTS
       Tcl_Interp   *interp      (in(1,8))      Interpreter  to   use   for   error(8,n)
                                           reporting.

       CONST char   *string(3,n)      (in(1,8))      Textual value to be converted.

       int          *intPtr      (out)     Points  to  place  to store integer
                                           value converted from string(3,n).

       double       *doublePtr   (out)     Points to place  to  store  double-
                                           precision floating-point value con-
                                           verted from string(3,n).

       int          *boolPtr     (out)     Points to place  to  store  boolean
                                           value   (0  or  1)  converted  from
                                           string(3,n).
_________________________________________________________________


DESCRIPTION
       These procedures convert from strings to integers  or  double-precision
       floating-point  values or booleans (represented as 0- or 1-valued inte-
       gers).  Each of the procedures takes a string(3,n) argument, converts it  to
       an  internal  form of a particular type, and stores the converted value
       at the location indicated by the procedure's third  argument.   If  all
       goes  well,  each  of the procedures returns TCL_OK.  If string(3,n) doesn't
       have the proper syntax for the desired type then TCL_ERROR is returned,
       an  error(8,n)  message  is left in(1,8) the interpreter's result, and nothing is
       stored at *intPtr or *doublePtr or *boolPtr.

       Tcl_GetInt expects string(3,n) to consist of a collection of integer digits,
       optionally signed and optionally preceded by white space.  If the first
       two characters of string(3,n) are ``0x'' then string(3,n) is expected  to  be  in(1,8)
       hexadecimal form;  otherwise, if(3,n) the first character of string(3,n) is ``0''
       then string(3,n) is expected to be in(1,8)  octal  form;   otherwise,  string(3,n)  is
       expected to be in(1,8) decimal form.

       Tcl_GetDouble  expects  string(3,n)  to  consist of a floating-point number,
       which is:  white space;  a sign;  a  sequence  of  digits;   a  decimal
       point;   a sequence of digits;  the letter ``e'';  and a signed decimal
       exponent.  Any of the fields may be omitted,  except  that  the  digits
       either  before  or  after  the decimal point must be present and if(3,n) the
       ``e'' is present then it must be followed by the exponent number.

       Tcl_GetBoolean expects string(3,n) to specify a boolean value.  If string(3,n) is
       any of 0, false, no, or off, then Tcl_GetBoolean stores a zero value at
       *boolPtr.  If string(3,n) is any of 1, true, yes, or on, then 1 is stored at
       *boolPtr.   Any  of  these  values  may  be abbreviated, and upper-case
       spellings are also acceptable.


KEYWORDS
       boolean, conversion, double, floating-point, integer



Tcl                                                              Tcl_GetInt(3)

References for this manual (incoming links)