tcl_newdoubleobj(3tcl) [opensolaris man page]

Tcl_DoubleObj(3TCL)					      Tcl Library Procedures					       Tcl_DoubleObj(3TCL)

__________________________________________________________________________________________________________________________________________________

NAME

       Tcl_NewDoubleObj, Tcl_SetDoubleObj, Tcl_GetDoubleFromObj - manipulate Tcl objects as floating-point values

SYNOPSIS

       #include <tcl.h>

       Tcl_Obj *
       Tcl_NewDoubleObj(doubleValue)

       Tcl_SetDoubleObj(objPtr, doubleValue)

       int
       Tcl_GetDoubleFromObj(interp, objPtr, doublePtr)

ARGUMENTS

       double	    doubleValue   (in)	    A double-precision floating point value used to initialize or set a double object.

       Tcl_Obj	    *objPtr	  (in/out)  For Tcl_SetDoubleObj, this points to the object to be converted to double type.  For Tcl_GetDoubleFro-
					    mObj, this refers to the object from which to get a double value; if objPtr does not already point	to
					    a double 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.

       double	    *doublePtr	  (out)     Points to place to store the double value obtained from objPtr.
_________________________________________________________________

DESCRIPTION

       These procedures are used to create, modify, and read double Tcl objects from C code.  Tcl_NewDoubleObj and Tcl_SetDoubleObj will create  a
       new  object  of	double type or modify an existing object to have double type.  Both of these procedures set the object to have the double-
       precision floating point value given by doubleValue; Tcl_NewDoubleObj returns a pointer to a newly  created  object  with  reference  count
       zero.   Both  procedures set the object's type to be double and assign the double value to the object's internal representation doubleValue
       member.	Tcl_SetDoubleObj invalidates any old string representation and, if the object is not already a double object, frees any old inter-
       nal representation.

       Tcl_GetDoubleFromObj  attempts  to return a double value from the Tcl object objPtr.  If the object is not already a double 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, it returns TCL_OK and stores the double value in the address given by doublePtr.  If the
       object is not already a double object, the conversion will free any old internal representation.

SEE ALSO

       Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult

KEYWORDS

       double, double object, double type, internal representation, object, object type, string representation

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +--------------------+-----------------+
       |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
       +--------------------+-----------------+
       |Availability	    | SUNWTcl	      |
       +--------------------+-----------------+
       |Interface Stability | Uncommitted     |
       +--------------------+-----------------+
NOTES

       Source for Tcl is available on http://opensolaris.org.

Tcl									8.0						       Tcl_DoubleObj(3TCL)

Check Out this Related Man Page

Tcl_DoubleObj(3)					      Tcl Library Procedures						  Tcl_DoubleObj(3)

__________________________________________________________________________________________________________________________________________________

NAME

       Tcl_NewDoubleObj, Tcl_SetDoubleObj, Tcl_GetDoubleFromObj - manipulate Tcl objects as floating-point values

SYNOPSIS

       #include <tcl.h>

       Tcl_Obj *
       Tcl_NewDoubleObj(doubleValue)

       Tcl_SetDoubleObj(objPtr, doubleValue)

       int
       Tcl_GetDoubleFromObj(interp, objPtr, doublePtr)

ARGUMENTS

       double doubleValue (in)		    A double-precision floating-point value used to initialize or set a Tcl object.

       Tcl_Obj *objPtr (in/out) 	    For  Tcl_SetDoubleObj, this points to the object in which to store a double value.	For Tcl_GetDouble-
					    FromObj, this refers to the object from which to retrieve a double value.

       Tcl_Interp *interp (in/out)	    When non-NULL, an error message is left here when double value retrieval fails.

       double *doublePtr (out)		    Points to place to store the double value obtained from objPtr.
_________________________________________________________________

DESCRIPTION

       These procedures are used to create, modify, and read Tcl objects that hold double-precision floating-point values.

       Tcl_NewDoubleObj creates and returns a new Tcl object initialized to the double value doubleValue.  The returned Tcl object is unshared.

       Tcl_SetDoubleObj sets the value of an existing Tcl object pointed to by objPtr to the double value doubleValue.	The objPtr  argument  must
       point  to  an  unshared Tcl object.  Any attempt to set the value of a shared Tcl object violates Tcl's copy-on-write policy.  Any existing
       string representation or internal representation in the unshared Tcl object will be freed as a consequence of setting the new value.

       Tcl_GetDoubleFromObj attempts to retreive a double value from the Tcl object objPtr.  If the attempt succeeds, then TCL_OK is returned, and
       the  double  value  is  written to the storage pointed to by doublePtr.	If the attempt fails, then TCL_ERROR is returned, and if interp is
       non-NULL, an error message is left in interp.  The Tcl_ObjType of objPtr may be changed to make subsequent  calls  to  Tcl_GetDoubleFromObj
       more efficient.

SEE ALSO

       Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult

KEYWORDS

       double, double object, double type, internal representation, object, object type, string representation

Tcl									8.0							  Tcl_DoubleObj(3)

Linux and UNIX Man Pages

tcl_newdoubleobj(3tcl) [opensolaris man page]

Check Out this Related Man Page