diff options
author | hobbs <hobbs@noemail.net> | 2000-04-14 23:01:45 (GMT) |
---|---|---|
committer | hobbs <hobbs@noemail.net> | 2000-04-14 23:01:45 (GMT) |
commit | 8291cc43dae0987322b9611a697c5adcba3ed4a8 (patch) | |
tree | 322db9cdfb9259a6dd4745e0a6e00e2223e5c44b /doc | |
parent | ca5a6fb1f3f7a44112977c2eb24d9f447fc028fa (diff) | |
download | tcl-8291cc43dae0987322b9611a697c5adcba3ed4a8.zip tcl-8291cc43dae0987322b9611a697c5adcba3ed4a8.tar.gz tcl-8291cc43dae0987322b9611a697c5adcba3ed4a8.tar.bz2 |
* doc/AppInit.3:
* doc/Async.3:
* doc/BackgdErr.3:
* doc/CrtChannel.3:
* doc/CrtInterp.3:
* doc/CrtMathFnc.3:
* doc/DString.3:
* doc/Eval.3:
* doc/ExprLong.3:
* doc/GetInt.3:
* doc/GetOpnFl.3:
* doc/Interp.3:
* doc/LinkVar.3:
* doc/OpenFileChnl.3:
* doc/OpenTcp.3:
* doc/PkgRequire.3:
* doc/RecordEval.3:
* doc/SetResult.3:
* doc/SplitList.3:
* doc/StaticPkg.3:
* doc/TraceVar.3:
* doc/Translate.3:
* doc/UpVar.3:
* doc/load.n: removed or updated references to interp->result use.
FossilOrigin-Name: 66905b808be8da8a5013f9443c47fbf7058d1c2f
Diffstat (limited to 'doc')
-rw-r--r-- | doc/AppInit.3 | 4 | ||||
-rw-r--r-- | doc/Async.3 | 14 | ||||
-rw-r--r-- | doc/BackgdErr.3 | 4 | ||||
-rw-r--r-- | doc/CrtChannel.3 | 6 | ||||
-rw-r--r-- | doc/CrtInterp.3 | 10 | ||||
-rw-r--r-- | doc/CrtMathFnc.3 | 4 | ||||
-rw-r--r-- | doc/DString.3 | 4 | ||||
-rw-r--r-- | doc/Eval.3 | 26 | ||||
-rw-r--r-- | doc/ExprLong.3 | 8 | ||||
-rw-r--r-- | doc/GetInt.3 | 4 | ||||
-rw-r--r-- | doc/GetOpnFl.3 | 4 | ||||
-rw-r--r-- | doc/Interp.3 | 5 | ||||
-rw-r--r-- | doc/LinkVar.3 | 4 | ||||
-rw-r--r-- | doc/OpenFileChnl.3 | 6 | ||||
-rw-r--r-- | doc/OpenTcp.3 | 10 | ||||
-rw-r--r-- | doc/PkgRequire.3 | 6 | ||||
-rw-r--r-- | doc/RecordEval.3 | 4 | ||||
-rw-r--r-- | doc/SetResult.3 | 4 | ||||
-rw-r--r-- | doc/SplitList.3 | 22 | ||||
-rw-r--r-- | doc/StaticPkg.3 | 15 | ||||
-rw-r--r-- | doc/TraceVar.3 | 4 | ||||
-rw-r--r-- | doc/Translate.3 | 6 | ||||
-rw-r--r-- | doc/UpVar.3 | 5 | ||||
-rw-r--r-- | doc/load.n | 4 |
24 files changed, 82 insertions, 101 deletions
diff --git a/doc/AppInit.3 b/doc/AppInit.3 index 15ea1e8..3412799 100644 --- a/doc/AppInit.3 +++ b/doc/AppInit.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: AppInit.3,v 1.2 1998/09/14 18:39:46 stanton Exp $ +'\" RCS: @(#) $Id: AppInit.3,v 1.3 2000/04/14 23:01:48 hobbs Exp $ '\" .so man.macros .TH Tcl_AppInit 3 7.0 Tcl "Tcl Library Procedures" @@ -51,7 +51,7 @@ Invoke a startup script to initialize the application. .LP \fBTcl_AppInit\fR returns TCL_OK or TCL_ERROR. If it returns TCL_ERROR then it must leave an error message in -\fIinterp->result\fR; otherwise the result is ignored. +for the interpreter's result; otherwise the result is ignored. .PP In addition to \fBTcl_AppInit\fR, your application should also contain a procedure \fBmain\fR that calls \fBTcl_Main\fR as follows: diff --git a/doc/Async.3 b/doc/Async.3 index 5086557..81c5cd1 100644 --- a/doc/Async.3 +++ b/doc/Async.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Async.3,v 1.3 1999/04/16 00:46:30 stanton Exp $ +'\" RCS: @(#) $Id: Async.3,v 1.4 2000/04/14 23:01:48 hobbs Exp $ '\" .so man.macros .TH Tcl_AsyncCreate 3 7.0 Tcl "Tcl Library Procedures" @@ -90,8 +90,8 @@ execution in an interpreter, then \fIinterp\fR will identify the interpreter in which the command was evaluated and \fIcode\fR will be the completion code returned by that command. -The command's result will be present in \fIinterp->result\fR. -When \fIproc\fR returns, whatever it leaves in \fIinterp->result\fR +The command's result will be present in the interpreter's result. +When \fIproc\fR returns, whatever it leaves in the interpreter's result will be returned as the result of the command and the integer value returned by \fIproc\fR will be used as the new completion code for the command. @@ -127,7 +127,7 @@ not be invoked. If multiple handlers become active at the same time, the handlers are invoked in the order they were created (oldest handler first). -The \fIcode\fR and \fIinterp->result\fR for later handlers +The \fIcode\fR and the interpreter's result for later handlers reflect the values returned by earlier handlers, so that the most recently created handler has last say about the interpreter's result and completion code. @@ -139,17 +139,17 @@ this over and over until there are no longer any ready handlers. .SH WARNING .PP It is almost always a bad idea for an asynchronous event -handler to modify \fIinterp->result\fR or return a code different +handler to modify the interpreter's result or return a code different from its \fIcode\fR argument. This sort of behavior can disrupt the execution of scripts in subtle ways and result in bugs that are extremely difficult to track down. If an asynchronous event handler needs to evaluate Tcl scripts -then it should first save \fIinterp->result\fR plus the values +then it should first save the interpreter's result plus the values of the variables \fBerrorInfo\fR and \fBerrorCode\fR (this can be done, for example, by storing them in dynamic strings). When the asynchronous handler is finished it should restore -\fIinterp->result\fR, \fBerrorInfo\fR, and \fBerrorCode\fR, +the interpreter's result, \fBerrorInfo\fR, and \fBerrorCode\fR, and return the \fIcode\fR argument. .SH KEYWORDS diff --git a/doc/BackgdErr.3 b/doc/BackgdErr.3 index 72d1530..1ac84c4 100644 --- a/doc/BackgdErr.3 +++ b/doc/BackgdErr.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: BackgdErr.3,v 1.2 1998/09/14 18:39:46 stanton Exp $ +'\" RCS: @(#) $Id: BackgdErr.3,v 1.3 2000/04/14 23:01:48 hobbs Exp $ '\" .so man.macros .TH Tcl_BackgroundError 3 7.5 Tcl "Tcl Library Procedures" @@ -33,7 +33,7 @@ obvious way for that code to report the error to the user. In these cases the code calls \fBTcl_BackgroundError\fR with an \fIinterp\fR argument identifying the interpreter in which the error occurred. At the time \fBTcl_BackgroundError\fR is invoked, -\fIinterp->result\fR is expected to contain an error message. +the interpreter's result is expected to contain an error message. \fBTcl_BackgroundError\fR will invoke the \fBbgerror\fR Tcl command to report the error in an application-specific fashion. If no \fBbgerror\fR command exists, or if it returns with an error condition, diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 7ee17b9..f95f653 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -4,7 +4,7 @@ '\" 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.4 1999/08/21 19:40:47 hobbs Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.5 2000/04/14 23:01:49 hobbs Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -277,7 +277,7 @@ and no further driver operations will be invoked on this instance after calling the \fIcloseProc\fR. If the close operation is successful, the procedure should return zero; otherwise it should return a nonzero POSIX error code. In addition, if an error occurs and \fIinterp\fR is not NULL, -the procedure should store an error message in \fIinterp->result\fR. +the procedure should store an error message in the interpreter's result. .PP .VS Alternatively, channels that support closing the read and write sides @@ -305,7 +305,7 @@ flags cleared. In all cases, the \fIclose2Proc\fR function should return zero if the close operation was successful; otherwise it should return a nonzero POSIX error code. In addition, if an error occurs and \fIinterp\fR is not NULL, the procedure should store an error message -in \fIinterp->result\fR. +in the interpreter's result. .VE .SH INPUTPROC diff --git a/doc/CrtInterp.3 b/doc/CrtInterp.3 index c8e69ef..f82e225 100644 --- a/doc/CrtInterp.3 +++ b/doc/CrtInterp.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtInterp.3,v 1.4 1999/08/21 19:40:47 hobbs Exp $ +'\" RCS: @(#) $Id: CrtInterp.3,v 1.5 2000/04/14 23:01:49 hobbs Exp $ '\" .so man.macros .TH Tcl_CreateInterp 3 7.5 Tcl "Tcl Library Procedures" @@ -49,10 +49,10 @@ resources associated with it, including variables, procedures, and application-specific command bindings, will be deleted. After \fBTcl_DeleteInterp\fR returns any attempt to use \fBTcl_Eval\fR on the interpreter will fail and return \fBTCL_ERROR\fR. After the call to -\fBTcl_DeleteInterp\fR it is safe to examine \fIinterp->result\fR, query or -set the values of variables, define, undefine or retrieve procedures, and -examine the runtime evaluation stack. See below, in the section -\fBINTERPRETERS AND MEMORY MANAGEMENT\fR for details. +\fBTcl_DeleteInterp\fR it is safe to examine the interpreter's result, +query or set the values of variables, define, undefine or retrieve +procedures, and examine the runtime evaluation stack. See below, in the +section \fBINTERPRETERS AND MEMORY MANAGEMENT\fR for details. .PP \fBTcl_InterpDeleted\fR returns nonzero if \fBTcl_DeleteInterp\fR was called with \fIinterp\fR as its argument; this indicates that the diff --git a/doc/CrtMathFnc.3 b/doc/CrtMathFnc.3 index 21a7761..188ae5a 100644 --- a/doc/CrtMathFnc.3 +++ b/doc/CrtMathFnc.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtMathFnc.3,v 1.2 1998/09/14 18:39:47 stanton Exp $ +'\" RCS: @(#) $Id: CrtMathFnc.3,v 1.3 2000/04/14 23:01:49 hobbs Exp $ '\" .so man.macros .TH Tcl_CreateMathFunc 3 7.0 Tcl "Tcl Library Procedures" @@ -87,7 +87,7 @@ It should set also \fIresultPtr->type\fR to either TCL_INT or TCL_DOUBLE to indicate which value was set. Under normal circumstances \fIproc\fR should return TCL_OK. If an error occurs while executing the function, \fIproc\fR should -return TCL_ERROR and leave an error message in \fIinterp->result\fR. +return TCL_ERROR and leave an error message in the interpreter's result. .SH KEYWORDS expression, mathematical function diff --git a/doc/DString.3 b/doc/DString.3 index 42890a5..ae2b966 100644 --- a/doc/DString.3 +++ b/doc/DString.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: DString.3,v 1.4 1999/04/21 21:50:22 rjohnson Exp $ +'\" RCS: @(#) $Id: DString.3,v 1.5 2000/04/14 23:01:50 hobbs Exp $ '\" .so man.macros .TH Tcl_DString 3 7.4 Tcl "Tcl Library Procedures" @@ -136,7 +136,7 @@ and reinitializes the string's value to an empty string. .PP \fBTcl_DStringResult\fR sets the result of \fIinterp\fR to the value of the dynamic string given by \fIdsPtr\fR. It does this by moving -a pointer from \fIdsPtr\fR to \fIinterp->result\fR. +a pointer from \fIdsPtr\fR to the interpreter's result. This saves the cost of allocating new memory and copying the string. \fBTcl_DStringResult\fR also reinitializes the dynamic string to an empty string. @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Eval.3,v 1.5 1999/08/19 02:58:34 hobbs Exp $ +'\" RCS: @(#) $Id: Eval.3,v 1.6 2000/04/14 23:01:50 hobbs Exp $ '\" .so man.macros .TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures" @@ -108,18 +108,18 @@ of the words for the Tcl command, one word in each object in \fIobjv\fR. \fBTcl_EvalObjv\fR evaluates the command and returns a completion code and result just like \fBTcl_EvalObjEx\fR. .PP -\fBTcl_Eval\fR is similar to \fBTcl_EvalObjEx\fR except that -the script to be executed is supplied as a string instead of an -object and no compilation occurs. The string is parsed and executed -directly (using \fBTcl_EvalObjv\fR) instead of compiling it and -executing the bytecodes. In situations where it is known that the -script will never be executed again, \fBTcl_Eval\fR may be -faster than \fBTcl_EvalObjEx\fR. \fBTcl_Eval\fR returns a completion -code and result just like \fBTcl_EvalObjEx\fR. Note: for backward -compatibility with versions before Tcl 8.0, \fBTcl_Eval\fR -copies the object result in \fIinterp\fR to \fIinterp->result\fR -where it can be accessed directly. This makes \fBTcl_Eval\fR somewhat -slower than \fBTcl_EvalEx\fR, which doesn't do the copy. +\fBTcl_Eval\fR is similar to \fBTcl_EvalObjEx\fR except that the script to +be executed is supplied as a string instead of an object and no compilation +occurs. The string is parsed and executed directly (using +\fBTcl_EvalObjv\fR) instead of compiling it and executing the bytecodes. +In situations where it is known that the script will never be executed +again, \fBTcl_Eval\fR may be faster than \fBTcl_EvalObjEx\fR. +\fBTcl_Eval\fR returns a completion code and result just like +\fBTcl_EvalObjEx\fR. Note: for backward compatibility with versions before +Tcl 8.0, \fBTcl_Eval\fR copies the object result in \fIinterp\fR to +\fIinterp->result\fR (use is deprecated) where it can be accessed directly. +This makes \fBTcl_Eval\fR somewhat slower than \fBTcl_EvalEx\fR, which +doesn't do the copy. .PP \fBTcl_EvalEx\fR is an extended version of \fBTcl_Eval\fR that takes additional arguments \fInumBytes\fR and \fIflags\fR. For the diff --git a/doc/ExprLong.3 b/doc/ExprLong.3 index ba15782..caca85c 100644 --- a/doc/ExprLong.3 +++ b/doc/ExprLong.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ExprLong.3,v 1.2 1998/09/14 18:39:48 stanton Exp $ +'\" RCS: @(#) $Id: ExprLong.3,v 1.3 2000/04/14 23:01:50 hobbs Exp $ '\" .so man.macros .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures" @@ -63,15 +63,13 @@ that is more efficient to execute. The \fIinterp\fR argument refers to an interpreter used to evaluate the expression (e.g. for variables and nested Tcl commands) and to return error information. -\fIinterp->result\fR is assumed to be initialized -in the standard fashion when they are invoked. .PP For all of these procedures the return value is a standard Tcl result: \fBTCL_OK\fR means the expression was successfully evaluated, and \fBTCL_ERROR\fR means that an error occurred while evaluating the expression. If \fBTCL_ERROR\fR is returned then -\fIinterp->result\fR will hold a message describing the error. +the interpreter's result will hold a message describing the error. If an error occurs while executing a Tcl command embedded in the expression then that error will be returned. .PP @@ -99,7 +97,7 @@ it must be one of the values accepted by \fBTcl_GetBoolean\fR such as ``yes'' or ``no'', or else an error occurs. .PP \fBTcl_ExprString\fR returns the value of the expression as a -string stored in \fIinterp->result\fR. +string stored in the interpreter's result. If the expression's actual value is an integer then \fBTcl_ExprString\fR converts it to a string using \fBsprintf\fR with a ``%d'' converter. diff --git a/doc/GetInt.3 b/doc/GetInt.3 index 473a12f..54f0250 100644 --- a/doc/GetInt.3 +++ b/doc/GetInt.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetInt.3,v 1.2 1998/09/14 18:39:48 stanton Exp $ +'\" RCS: @(#) $Id: GetInt.3,v 1.3 2000/04/14 23:01:51 hobbs Exp $ '\" .so man.macros .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures" @@ -49,7 +49,7 @@ the converted value at the location indicated by the procedure's third argument. If all goes well, each of the procedures returns TCL_OK. If \fIstring\fR doesn't have the proper syntax for the desired type then TCL_ERROR is returned, an error message is left -in \fIinterp->result\fR, and nothing is stored at *\fIintPtr\fR +in the interpreter's result, and nothing is stored at *\fIintPtr\fR or *\fIdoublePtr\fR or *\fIboolPtr\fR. .PP \fBTcl_GetInt\fR expects \fIstring\fR to consist of a collection diff --git a/doc/GetOpnFl.3 b/doc/GetOpnFl.3 index 38c7a07..be13875 100644 --- a/doc/GetOpnFl.3 +++ b/doc/GetOpnFl.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetOpnFl.3,v 1.2 1998/09/14 18:39:48 stanton Exp $ +'\" RCS: @(#) $Id: GetOpnFl.3,v 1.3 2000/04/14 23:01:51 hobbs Exp $ .so man.macros .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -49,7 +49,7 @@ and writing. If an error occurs in \fBTcl_GetOpenFile\fR (e.g. \fIstring\fR didn't make any sense or \fIcheckUsage\fR was set and the file wasn't opened for the access specified by \fIwrite\fR) then TCL_ERROR is returned -and \fIinterp->result\fR will contain an error message. +and the interpreter's result will contain an error message. In the current implementation \fIcheckUsage\fR is ignored and consistency checks are always performed. .VS diff --git a/doc/Interp.3 b/doc/Interp.3 index db08dcd..b6c2c0f 100644 --- a/doc/Interp.3 +++ b/doc/Interp.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Interp.3,v 1.2 1998/09/14 18:39:49 stanton Exp $ +'\" RCS: @(#) $Id: Interp.3,v 1.3 2000/04/14 23:01:51 hobbs Exp $ '\" .so man.macros .TH Tcl_Interp 3 7.5 Tcl "Tcl Library Procedures" @@ -107,7 +107,8 @@ returning an error) will generally assume that the result has been initialized when the procedure is called. If such a procedure is to be called after the result has been changed, then \fBTcl_ResetResult\fR should be called first to -reset the result to its initialized state. +reset the result to its initialized state. The direct use of +\fIinterp->result\fR is strongly deprecated (see \fBTcl_SetResult\fR). .PP The \fIerrorLine\fR field is valid only after \fBTcl_Eval\fR returns diff --git a/doc/LinkVar.3 b/doc/LinkVar.3 index 25d3c17..0a4a58f 100644 --- a/doc/LinkVar.3 +++ b/doc/LinkVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: LinkVar.3,v 1.2 1998/09/14 18:39:49 stanton Exp $ +'\" RCS: @(#) $Id: LinkVar.3,v 1.3 2000/04/14 23:01:51 hobbs Exp $ '\" .so man.macros .TH Tcl_LinkVar 3 7.5 Tcl "Tcl Library Procedures" @@ -48,7 +48,7 @@ be returned, and whenever the Tcl variable is written the C variable will be updated to have the same value. \fBTcl_LinkVar\fR normally returns TCL_OK; if an error occurs while setting up the link (e.g. because \fIvarName\fR is the -name of array) then TCL_ERROR is returned and \fIinterp->result\fR +name of array) then TCL_ERROR is returned and the interpreter's result contains an error message. .PP The \fItype\fR argument specifies the type of the C variable, diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3 index d0d751a..1e56009 100644 --- a/doc/OpenFileChnl.3 +++ b/doc/OpenFileChnl.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.7 1999/08/21 19:40:47 hobbs Exp $ +'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.8 2000/04/14 23:01:52 hobbs Exp $ .so man.macros .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -264,7 +264,7 @@ If an error occurs while opening the channel, \fBTcl_OpenCommandChannel\fR returns NULL and records a POSIX error code that can be retrieved with \fBTcl_GetErrno\fR. In addition, \fBTcl_OpenCommandChannel\fR leaves an error message in -\fIinterp->result\fR if \fIinterp\fR is not NULL. +the interpreter's result if \fIinterp\fR is not NULL. .PP The newly created channel is not registered in the supplied interpreter; to register it, use \fBTcl_RegisterChannel\fR, described below. @@ -544,7 +544,7 @@ error code. set. The procedure normally returns \fBTCL_OK\fR. If an error occurs, it returns \fBTCL_ERROR\fR; in addition, if \fIinterp\fR is non-NULL, -\fBTcl_SetChannelOption\fR leaves an error message in \fIinterp->result\fR. +\fBTcl_SetChannelOption\fR leaves an error message in the interpreter's result. .SH TCL_EOF .PP diff --git a/doc/OpenTcp.3 b/doc/OpenTcp.3 index 6f5da00..9b2b8d9 100644 --- a/doc/OpenTcp.3 +++ b/doc/OpenTcp.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: OpenTcp.3,v 1.2 1998/09/14 18:39:49 stanton Exp $ +'\" RCS: @(#) $Id: OpenTcp.3,v 1.3 2000/04/14 23:01:52 hobbs Exp $ .so man.macros .TH Tcl_OpenTcpClient 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -28,7 +28,7 @@ Tcl_Channel .AS Tcl_ChannelType newClientProcPtr in .AP Tcl_Interp *interp in Tcl interpreter to use for error reporting. If non-NULL and an -error occurs, an error message is left in \fIinterp->result\fR. +error occurs, an error message is left in the interpreter's result. .AP int port in A port number to connect to as a client or to listen on as a server. .AP char *host in @@ -91,7 +91,7 @@ If an error occurs in opening the socket, \fBTcl_OpenTcpClient\fR returns NULL and records a POSIX error code that can be retrieved with \fBTcl_GetErrno\fR. In addition, if \fIinterp\fR is non-NULL, an error message -is left in \fIinterp->result\fR. +is left in the interpreter's result. .PP The newly created channel is not registered in the supplied interpreter; to register it, use \fBTcl_RegisterChannel\fR. @@ -143,8 +143,8 @@ connection it can close \fIchannel\fR. representing the server socket. If an error occurs, \fBTcl_OpenTcpServer\fR returns NULL and records a POSIX error code that can be retrieved with \fBTcl_GetErrno\fR. -In addition, if \fIinterp->result\fR is non-NULL, an error message -is left in \fIinterp->result\fR. +In addition, if the interpreter is non-NULL, an error message +is left in the interpreter's result. .PP The channel returned by \fBTcl_OpenTcpServer\fR cannot be used for either input or output. diff --git a/doc/PkgRequire.3 b/doc/PkgRequire.3 index 796ee6f..40cd542 100644 --- a/doc/PkgRequire.3 +++ b/doc/PkgRequire.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: PkgRequire.3,v 1.3 1999/03/10 05:52:45 stanton Exp $ +'\" RCS: @(#) $Id: PkgRequire.3,v 1.4 2000/04/14 23:01:53 hobbs Exp $ '\" .so man.macros .TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures" @@ -72,11 +72,11 @@ If \fBTcl_PkgPresent\fR or \fBTcl_PkgRequire\fR complete successfully they return a pointer to the version string for the version of the package that is provided in the interpreter (which may be different than \fIversion\fR); if an error occurs they return NULL and leave an error -message in \fIinterp->result\fR. +message in the interpreter's result. .PP \fBTcl_PkgProvide\fR returns TCL_OK if it completes successfully; if an error occurs it returns TCL_ERROR and leaves an error message -in \fIinterp->result\fR. +in the interpreter's result. .PP \fBTcl_PkgProvideEx\fR, \fBTcl_PkgPresentEx\fR and \fBTcl_PkgRequireEx\fR allow the setting and retrieving of the client data associated with diff --git a/doc/RecordEval.3 b/doc/RecordEval.3 index 090a56d..7621b6d 100644 --- a/doc/RecordEval.3 +++ b/doc/RecordEval.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: RecordEval.3,v 1.2 1998/09/14 18:39:50 stanton Exp $ +'\" RCS: @(#) $Id: RecordEval.3,v 1.3 2000/04/14 23:01:53 hobbs Exp $ '\" .so man.macros .TH Tcl_RecordAndEval 3 7.4 Tcl "Tcl Library Procedures" @@ -36,7 +36,7 @@ the command at global level instead of the current stack level. on the history list and then execute it using \fBTcl_Eval\fR (or \fBTcl_GlobalEval\fR if the TCL_EVAL_GLOBAL bit is set in \fIflags\fR). It returns a completion code such as TCL_OK just like \fBTcl_Eval\fR -and it leaves information in \fIinterp->result\fR. +and it leaves information in the interpreter's result. If you don't want the command recorded on the history list then you should invoke \fBTcl_Eval\fR instead of \fBTcl_RecordAndEval\fR. Normally \fBTcl_RecordAndEval\fR is only called with top-level diff --git a/doc/SetResult.3 b/doc/SetResult.3 index c8b8a87..a31c9cd 100644 --- a/doc/SetResult.3 +++ b/doc/SetResult.3 @@ -5,10 +5,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetResult.3,v 1.4 1999/08/21 19:40:47 hobbs Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.5 2000/04/14 23:01:53 hobbs Exp $ '\" .so man.macros -.TH Tcl_SetResult 3 7.5 Tcl "Tcl Library Procedures" +.TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures" .BS .SH NAME Tcl_SetObjResult, Tcl_GetObjResult, Tcl_SetResult, Tcl_GetStringResult, Tcl_AppendResult, Tcl_AppendResultVA, Tcl_AppendElement, Tcl_ResetResult \- manipulate Tcl result diff --git a/doc/SplitList.3 b/doc/SplitList.3 index e30771c..79421fb 100644 --- a/doc/SplitList.3 +++ b/doc/SplitList.3 @@ -5,10 +5,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SplitList.3,v 1.2 1998/09/14 18:39:50 stanton Exp $ +'\" RCS: @(#) $Id: SplitList.3,v 1.3 2000/04/14 23:01:53 hobbs Exp $ '\" .so man.macros -.TH Tcl_SplitList 3 7.5 Tcl "Tcl Library Procedures" +.TH Tcl_SplitList 3 8.0 Tcl "Tcl Library Procedures" .BS .SH NAME Tcl_SplitList, Tcl_Merge, Tcl_ScanElement, Tcl_ConvertElement \- manipulate Tcl lists @@ -24,26 +24,20 @@ char * .sp int \fBTcl_ScanElement\fR(\fIsrc, flagsPtr\fR) -.VS .sp int \fBTcl_ScanCountedElement\fR(\fIsrc, length, flagsPtr\fR) -.VE .sp int \fBTcl_ConvertElement\fR(\fIsrc, dst, flags\fR) -.VS .sp int \fBTcl_ConvertCountedElement\fR(\fIsrc, length, dst, flags\fR) -.VE .SH ARGUMENTS .AS Tcl_Interp ***argvPtr .AP Tcl_Interp *interp out -.VS Interpreter to use for error reporting. If NULL, then no error message is left. -.VE .AP char *list in Pointer to a string with proper list structure. .AP int *argcPtr out @@ -63,10 +57,8 @@ String that is to become an element of a list. .AP int *flagsPtr in Pointer to word to fill in with information about \fIsrc\fR. The value of *\fIflagsPtr\fR must be passed to \fBTcl_ConvertElement\fR. -.VS .AP int length in Number of bytes in string \fIsrc\fR. -.VE .AP char *dst in Place to copy converted list element. Must contain enough characters to hold converted string. @@ -99,19 +91,15 @@ code = Tcl_SplitList(interp, string, &argc, &argv); .CE Then you should eventually free the storage with a call like the following: -.VS .CS Tcl_Free((char *) argv); .CE -.VE .PP \fBTcl_SplitList\fR normally returns \fBTCL_OK\fR, which means the list was successfully parsed. If there was a syntax error in \fIlist\fR, then \fBTCL_ERROR\fR is returned -and \fIinterp->result\fR will point to an error message describing the -.VS +and the interpreter's result will point to an error message describing the problem (if \fIinterp\fR was not NULL). -.VE If \fBTCL_ERROR\fR is returned then no memory is allocated and \fI*argvPtr\fR is not modified. .PP @@ -126,11 +114,9 @@ it will be parsed into \fIargc\fR words whose values will be the same as the \fIargv\fR strings passed to \fBTcl_Merge\fR. \fBTcl_Merge\fR will modify the list elements with braces and/or backslashes in order to produce proper Tcl list structure. -.VS The result string is dynamically allocated using \fBTcl_Alloc\fR; the caller must eventually release the space using \fBTcl_Free\fR. -.VE .PP If the result of \fBTcl_Merge\fR is passed to \fBTcl_SplitList\fR, the elements returned by \fBTcl_SplitList\fR will be identical to @@ -180,12 +166,10 @@ used to generate a portion of an argument for a Tcl command. In this case, surrounding \fIsrc\fR with curly braces would cause the command not to be parsed correctly. .PP -.VS \fBTcl_ScanCountedElement\fR and \fBTcl_ConvertCountedElement\fR are the same as \fBTcl_ScanElement\fR and \fBTcl_ConvertElement\fR, except the length of string \fIsrc\fR is specified by the \fIlength\fR argument, and the string may contain embedded nulls. -.VE .SH KEYWORDS backslash, convert, element, list, merge, split, strings diff --git a/doc/StaticPkg.3 b/doc/StaticPkg.3 index e268b5f..39572a4 100644 --- a/doc/StaticPkg.3 +++ b/doc/StaticPkg.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StaticPkg.3,v 1.2 1998/09/14 18:39:50 stanton Exp $ +'\" RCS: @(#) $Id: StaticPkg.3,v 1.3 2000/04/14 23:01:54 hobbs Exp $ '\" .so man.macros .TH Tcl_StaticPackage 3 7.5 Tcl "Tcl Library Procedures" @@ -57,13 +57,12 @@ following prototype: .CS typedef int Tcl_PackageInitProc(Tcl_Interp *\fIinterp\fR); .CE -The \fIinterp\fR argument identifies the interpreter in which the -package is to be loaded. The initialization procedure must return -\fBTCL_OK\fR or \fBTCL_ERROR\fR to indicate whether or not it completed -successfully; in the event of an error it should set \fIinterp->result\fR -to point to an error message. -The result or error from the initialization procedure will be returned -as the result of the \fBload\fR command that caused the +The \fIinterp\fR argument identifies the interpreter in which the package +is to be loaded. The initialization procedure must return \fBTCL_OK\fR or +\fBTCL_ERROR\fR to indicate whether or not it completed successfully; in +the event of an error it should set the interpreter's result to point to an +error message. The result or error from the initialization procedure will +be returned as the result of the \fBload\fR command that caused the initialization procedure to be invoked. .SH KEYWORDS diff --git a/doc/TraceVar.3 b/doc/TraceVar.3 index 57a3350..226a460 100644 --- a/doc/TraceVar.3 +++ b/doc/TraceVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: TraceVar.3,v 1.3 1999/04/16 00:46:33 stanton Exp $ +'\" RCS: @(#) $Id: TraceVar.3,v 1.4 2000/04/14 23:01:54 hobbs Exp $ '\" .so man.macros .TH Tcl_TraceVar 3 7.4 Tcl "Tcl Library Procedures" @@ -72,7 +72,7 @@ whenever the variable is read or written or unset. If the trace is created successfully then \fBTcl_TraceVar\fR returns TCL_OK. If an error occurred (e.g. \fIvarName\fR specifies an element of an array, but the actual variable isn't an array) then TCL_ERROR -is returned and an error message is left in \fIinterp->result\fR. +is returned and an error message is left in the interpreter's result. .PP The \fIflags\fR argument to \fBTcl_TraceVar\fR indicates when the trace procedure is to be invoked and provides information diff --git a/doc/Translate.3 b/doc/Translate.3 index 5d0d598..d405be6 100644 --- a/doc/Translate.3 +++ b/doc/Translate.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Translate.3,v 1.3 1999/04/16 00:46:33 stanton Exp $ +'\" RCS: @(#) $Id: Translate.3,v 1.4 2000/04/14 23:01:54 hobbs Exp $ '\" .so man.macros .TH Tcl_TranslateFileName 3 8.1 Tcl "Tcl Library Procedures" @@ -51,12 +51,12 @@ initializes \fI*bufferPtr\fR even if it doesn't use it, so the call to .PP If an error occurs (e.g. because there was no user by the given name) then NULL is returned and an error message will be left -at \fIinterp->result\fR. +in the interpreter's result. When an error occurs, \fBTcl_TranslateFileName\fR frees the dynamic string itself so that the caller need not call \fBTcl_DStringFree\fR. .PP -The caller is responsible for making sure that \fIinterp->result\fR +The caller is responsible for making sure that the interpreter's result has its default empty value when \fBTcl_TranslateFileName\fR is invoked. .SH "SEE ALSO" diff --git a/doc/UpVar.3 b/doc/UpVar.3 index 8dcb06f..b487d71 100644 --- a/doc/UpVar.3 +++ b/doc/UpVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: UpVar.3,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: UpVar.3,v 1.3 2000/04/14 23:01:55 hobbs Exp $ '\" .so man.macros .TH Tcl_UpVar 3 7.4 Tcl "Tcl Library Procedures" @@ -64,8 +64,7 @@ The destination variable name is specified in a single string; it may not be an array element. .PP Both procedures return either TCL_OK or TCL_ERROR, and they -leave an error message in \fIinterp->result\fR if an error -occurs. +leave an error message in the interpreter's result if an error occurs. .PP As with the \fBupvar\fR command, the source variable need not exist; if it does exist, unsetting it later does not destroy the link. The @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: load.n,v 1.4 2000/02/10 09:53:53 hobbs Exp $ +'\" RCS: @(#) $Id: load.n,v 1.5 2000/04/14 23:01:55 hobbs Exp $ '\" .so man.macros .TH load n 7.5 Tcl "Tcl Built-In Commands" @@ -64,7 +64,7 @@ typedef int Tcl_PackageInitProc(Tcl_Interp *\fIinterp\fR); The \fIinterp\fR argument identifies the interpreter in which the package is to be loaded. The initialization procedure must return \fBTCL_OK\fR or \fBTCL_ERROR\fR to indicate whether or not it completed -successfully; in the event of an error it should set \fIinterp->result\fR +successfully; in the event of an error it should set the interpreter's result to point to an error message. The result of the \fBload\fR command will be the result returned by the initialization procedure. .PP |