TclBooleanObj(3) Tcl Library Procedures TclBooleanObj(3)

NAME
       TclNewBooleanObj,  TclSetBooleanObj,  TclGetBooleanFromObj - manipu-
       late Tcl objects as boolean values

SYNOPSIS
       ##iinncclluuddee <>

       TclObj *
       TTccllNNeewwBBoooolleeaannOObbjj(boolValue)

       TTccllSSeettBBoooolleeaannOObbjj(objPtr, boolValue)

       int
       TTccllGGeettBBoooolleeaannFFrroommOObbjj(interp, objPtr, boolPtr)

AARRGGUUMMEENNTTSS
       int          boolValue (in)      Integer value used  to  initialize  or
                                        set  a boolean object.  If the integer
                                        is nonzero, the boolean object is  set
                                        to  1; otherwise the boolean object is
                                        set to 0.

       TclObj      *objPtr   (in/out)  For TTccllSSeettBBoooolleeaannOObbjj, this points  to
                                        the  object to be converted to boolean
                                        type.  For TTccllGGeettBBoooolleeaannFFrroommOObbjj, this
                                        refers to the object from which to get
                                        a boolean value; if  objPtr  does  not
                                        already  point to a boolean object, an
                                        attempt will be made to convert it  to
                                        one.

       TclInterp   *interp   (in/out)  If  an error occurs during conversion,
                                        an error message is left in the inter-
                                        preter's  result  object unless interp
                                        is NULL.

       int          *boolPtr  (out)     Points to place where  TTccllGGeettBBoooolleeaann-
                                        FFrroommOObbjj stores the boolean value (0 or
                                        1) obtained from objPtr.



DESCRIPTION
       These procedures are used to  create,  modify,  and  read  boolean  Tcl
       objects from C code.  TTccllNNeewwBBoooolleeaannOObbjj and TTccllSSeettBBoooolleeaannOObbjj will cre-
       ate a new object of boolean type or modify an existing object  to  have
       boolean  type.   Both  of  these  procedures set the object to have the
       boolean value (0 or 1) specified by boolValue; if boolValue is nonzero,
       the  object  is  set to 1, otherwise to 0.  TTccllNNeewwBBoooolleeaannOObbjj returns a
       pointer to a newly created object with reference count zero.  Both pro-
       cedures  set  the  object's  type  to be boolean and assign the boolean
       value  to  the  object's  internal  representation  longValue   member.
       TTccllSSeettBBoooolleeaannOObbjj invalidates any old string representation and, if the
       object is not already a boolean object, frees any old  internal  repre-
       sentation.

       TTccllGGeettBBoooolleeaannFFrroommOObbjj  attempts  to return a boolean value from the Tcl
       object objPtr.  If the object is not already a boolean object, it  will
       attempt to convert it to one.  If an error occurs during conversion, it
       returns TTCCLLEERRRROORR and leaves an  error  message  in  the  interpreter's
       result  object unless interp is NULL.  Otherwise, TTccllGGeettBBoooolleeaannFFrroommOObbjj
       returns TTCCLLOOKK and stores the boolean value in  the  address  given  by
       boolPtr.  If the object is not already a boolean object, the conversion
       will free any old internal representation.   Objects  having  a  string
       representation  equal  to  any  of  00, ffaallssee, nnoo, or ooffff have a boolean
       value 0; if the string representation is any of 11, ttrruuee, yyeess, or oonn the
       boolean value is 1.  Any of these string values may be abbreviated, and
       upper-case spellings are also acceptable.


SEE ALSO
       TclNewObj, TclDecrRefCount, TclIncrRefCount, TclGetObjResult


KKEEYYWWOORRDDSS
       boolean, boolean object, boolean type, internal representation, object,
       object type, string representation



Tcl                                   8.0                    TclBooleanObj(3)