Tcl_BooleanObj (3)
manipulate Tcl objects as boolean values
SYNOPSIS
#include <tcl.h>
Tcl_Obj *
Tcl_NewBooleanObj(boolValue)
Tcl_SetBooleanObj(objPtr, boolValue)
int
Tcl_GetBooleanFromObj(interp, objPtr, boolPtr)
ARGUMENTS
Tcl_Interp *interp
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.
Tcl_Obj *objPtr in/out
For Tcl_SetBooleanObj, this points to the object to be converted
to boolean type.
For Tcl_GetBooleanFromObj, 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.
Tcl_Interp *interp in/out
If an error occurs during conversion,
an error message is left in the interpreter's result object
unless interp is NULL.
int *boolPtr out
Points to place where Tcl_GetBooleanFromObj
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.
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
'\"
'\" Copyright (c) 1996-1997 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: CrtChannel.3,v 1.2 1998/09/14 18:39:46 stanton Exp $
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
