diff options
Diffstat (limited to 'doc/IntObj.3')
| -rw-r--r-- | doc/IntObj.3 | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/doc/IntObj.3 b/doc/IntObj.3 new file mode 100644 index 0000000..a87ac92 --- /dev/null +++ b/doc/IntObj.3 @@ -0,0 +1,104 @@ +'\" +'\" 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. +'\" +'\" SCCS: @(#) @(#) IntObj.3 1.7 97/05/08 19:49:22 +'\" +.so man.macros +.TH Tcl_IntObj 3 8.0 Tcl "Tcl Library Procedures" +.BS +.SH NAME +Tcl_NewIntObj, Tcl_NewLongObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj \- manipulate Tcl objects as integers +.SH SYNOPSIS +.nf +\fB#include <tcl.h>\fR +.sp +Tcl_Obj * +\fBTcl_NewIntObj\fR(\fIintValue\fR) +.sp +Tcl_Obj * +\fBTcl_NewLongObj\fR(\fIlongValue\fR) +.sp +\fBTcl_SetIntObj\fR(\fIobjPtr, intValue\fR) +.sp +\fBTcl_SetLongObj\fR(\fIobjPtr, longValue\fR) +.sp +int +\fBTcl_GetIntFromObj\fR(\fIinterp, objPtr, intPtr\fR) +.sp +int +\fBTcl_GetLongFromObj\fR(\fIinterp, objPtr, longPtr\fR) +.SH ARGUMENTS +.AS Tcl_Interp *interp +.AP int intValue in +Integer value used to initialize or set an integer object. +.AP long longValue in +Long integer value used to initialize or set an integer object. +.AP Tcl_Obj *objPtr in/out +For \fBTcl_SetIntObj\fR and \fBTcl_SetLongObj\fR, +this points to the object to be converted to integer type. +For \fBTcl_GetIntFromObj\fR and \fBTcl_GetLongFromObj\fR, +this refers to the object +from which to get an integer or long integer value; +if \fIobjPtr\fR does not already point to an integer object, +an attempt will be made to convert it to one. +.AP Tcl_Interp *interp in/out +If an error occurs during conversion, +an error message is left in the interpreter's result object +unless \fIinterp\fR is NULL. +.AP int *intPtr out +Points to place to store the integer value +obtained by \fBTcl_GetIntFromObj\fR from \fIobjPtr\fR. +.AP long *longPtr out +Points to place to store the long integer value +obtained by \fBTcl_GetLongFromObj\fR from \fIobjPtr\fR. +.BE + +.SH DESCRIPTION +.PP +These procedures are used to create, modify, and read +integer Tcl objects from C code. +\fBTcl_NewIntObj\fR, \fBTcl_NewLongObj\fR, +\fBTcl_SetIntObj\fR, and \fBTcl_SetLongObj\fR +create a new object of integer type +or modify an existing object to have integer type. +\fBTcl_NewIntObj\fR and \fBTcl_SetIntObj\fR set the object to have the +integer value given by \fIintValue\fR, +while \fBTcl_NewLongObj\fR and \fBTcl_SetLongObj\fR +set the object to have the +long integer value given by \fIlongValue\fR. +\fBTcl_NewIntObj\fR and \fBTcl_NewLongObj\fR +return a pointer to a newly created object with reference count zero. +These procedures set the object's type to be integer +and assign the integer value to the object's internal representation +\fIlongValue\fR member. +\fBTcl_SetIntObj\fR and \fBTcl_SetLongObj\fR +invalidate any old string representation and, +if the object is not already an integer object, +free any old internal representation. +.PP +\fBTcl_GetIntFromObj\fR and \fBTcl_GetLongFromObj\fR +attempt to return an integer value from the Tcl object \fIobjPtr\fR. +If the object is not already an integer object, +they will attempt to convert it to one. +If an error occurs during conversion, they return \fBTCL_ERROR\fR +and leave an error message in the interpreter's result object +unless \fIinterp\fR is NULL. +Also, if the long integer held in the object's internal representation +\fIlongValue\fR member can not be represented in a (non-long) integer, +\fBTcl_GetIntFromObj\fR returns \fBTCL_ERROR\fR +and leaves an error message in the interpreter's result object +unless \fIinterp\fR is NULL. +Otherwise, both procedures return \fBTCL_OK\fR and +store the integer or the long integer value +in the address given by \fIintPtr\fR and \fIlongPtr\fR respectively. +If the object is not already an integer object, +the conversion will free any old internal representation. + +.SH "SEE ALSO" +Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult + +.SH KEYWORDS +integer, integer object, integer type, internal representation, object, object type, string representation |