diff options
| -rw-r--r-- | doc/IntObj.3 | 25 |
1 files changed, 11 insertions, 14 deletions
diff --git a/doc/IntObj.3 b/doc/IntObj.3 index 6e68448..c7730e6 100644 --- a/doc/IntObj.3 +++ b/doc/IntObj.3 @@ -4,13 +4,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: IntObj.3,v 1.10 2006/04/18 15:13:53 dkf Exp $ +'\" RCS: @(#) $Id: IntObj.3,v 1.11 2006/04/18 18:06:48 dgp Exp $ '\" .so man.macros .TH Tcl_IntObj 3 8.5 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_GetBignumAndClearObj \- manipulate Tcl_Obj values as integers +Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_GetBignumAndClearObj \- manipulate Tcl objects as integer values .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -73,18 +73,15 @@ to retrieve an integral value. When non-NULL, an error message is left here when integral value retrieval fails. .AP int *intPtr out -Points to place to store the integer value -obtained by \fBTcl_GetIntFromObj\fR from \fIobjPtr\fR. +Points to place to store the integer value retrieved from \fIobjPtr\fR. .AP long *longPtr out -Points to place to store the long integer value -obtained by \fBTcl_GetLongFromObj\fR from \fIobjPtr\fR. +Points to place to store the long integer value retrieved from \fIobjPtr\fR. .AP Tcl_WideInt *widePtr out -Points to place to store the wide integer value -obtained by \fBTcl_GetWideIntFromObj\fR from \fIobjPtr\fR. +Points to place to store the wide integer value retrieved from \fIobjPtr\fR. .AP mp_int *bigValue in/out .VS 8.5 -Points to a multi-precision integer structure consistent with -one declared by headers of the libtommath library. +Points to a multi-precision integer structure declared by the LibTomMath +library. .VE 8.5 .BE @@ -113,7 +110,7 @@ returned Tcl object is unshared. .PP The \fBTcl_SetIntObj\fR, \fBTcl_SetLongObj\fR, \fBTcl_SetWideIntObj\fR, and \fBTcl_SetBignumObj\fR routines each set the value of an existing -\fBTcl_Obj\fR pointed to by \fIobjPtr\fR to the integral value provided +Tcl object pointed to by \fIobjPtr\fR to the integral value provided by the other argument. The \fIobjPtr\fR 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 @@ -122,8 +119,8 @@ as a consequence of setting the new value. .PP The \fBTcl_GetIntFromObj\fR, \fBTcl_GetLongFromObj\fR, \fBTcl_GetWideIntFromObj\fR, \fBTcl_GetBignumFromObj\fR, and -\fBTcl_GetBignumAndClearObj\fR attempt to retrieve an integral value -of the appropriate type from the Tcl object \fIobjPtr\fR. If the +\fBTcl_GetBignumAndClearObj\fR routines attempt to retrieve an integral +value of the appropriate type from the Tcl object \fIobjPtr\fR. If the attempt succeeds, then \fBTCL_OK\fR is returned, and the value is written to the storage provided by the caller. The attempt might fail if \fIobjPtr\fR does not hold an integral value, or if the @@ -134,7 +131,7 @@ of \fIobjPtr\fR may be changed to make subsequent calls to the same routine more efficient. Unlike the other functions, \fBTcl_GetBignumAndClearObj\fR may set the content of the Tcl object \fIobjPtr\fR to an empty string in the process of retrieving the -multiple-precision integer library. +multiple-precision integer value. .PP The choice between \fBTcl_GetBignumFromObj\fR and \fBTcl_GetBignumAndClearObj\fR is governed by how the caller will |