DESCRIPTION
These procedures are used to create, modify, and read
boolean Tcl objects from C code.
Tcl_NewBooleanObj and Tcl_SetBooleanObj
will create 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.
Tcl_NewBooleanObj returns a pointer to a newly created object
with reference count zero.
Both procedures set the object's type to be boolean
and assign the boolean value to the object's internal representation
longValue member.
Tcl_SetBooleanObj invalidates any old string representation
and, if the object is not already a boolean object,
frees any old internal representation.
Tcl_GetBooleanFromObj 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 TCL_ERROR
and leaves an error message in the interpreter's result object
unless interp is NULL.
Otherwise, Tcl_GetBooleanFromObj returns TCL_OK
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.
SEE ALSO
Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult
KEYWORDS
boolean, boolean object, boolean type, internal representation, object, object type, string representation
Last change: 8.0
[ tcl8.0b1 | tk8.0b1 | X-ref ]
Copyright © 1989-1994 The Regents of the University of California.
Copyright © 1994-1997 Sun Microsystems, Inc.