summaryrefslogtreecommitdiffstats
path: root/doc/GetSelect.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2009-05-04 09:12:33 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2009-05-04 09:12:33 (GMT)
commitedb51ce9a769a68c10ade6ab78f8147852bf8f8c (patch)
tree446cc57d22761dad522be3eefbf621cdd2c06b75 /doc/GetSelect.3
parent6268aa893cfdba7b5051430275fc890212319ad5 (diff)
downloadtk-edb51ce9a769a68c10ade6ab78f8147852bf8f8c.zip
tk-edb51ce9a769a68c10ade6ab78f8147852bf8f8c.tar.gz
tk-edb51ce9a769a68c10ade6ab78f8147852bf8f8c.tar.bz2
Purge mention of interp->result. [Bug 2431507]
Diffstat (limited to 'doc/GetSelect.3')
-rw-r--r--doc/GetSelect.313
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/GetSelect.3 b/doc/GetSelect.3
index 7345cf1..9cdc1bd 100644
--- a/doc/GetSelect.3
+++ b/doc/GetSelect.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: GetSelect.3,v 1.6 2008/06/30 22:57:01 dkf Exp $
+'\" RCS: @(#) $Id: GetSelect.3,v 1.7 2009/05/04 09:12:33 dkf Exp $
'\"
.so man.macros
.TH Tk_GetSelection 3 4.0 Tk "Tk Library Procedures"
@@ -43,12 +43,14 @@ selection may actually be retrieved in several pieces; as each piece
is retrieved, \fIproc\fR is called to process the piece. \fIProc\fR
should have arguments and result that match the type
\fBTk_GetSelProc\fR:
+.PP
.CS
typedef int \fBTk_GetSelProc\fR(
ClientData \fIclientData\fR,
Tcl_Interp *\fIinterp\fR,
char *\fIportion\fR);
.CE
+.PP
The \fIclientData\fR and \fIinterp\fR parameters to \fIproc\fR
will be copies of the corresponding arguments to
\fBTk_GetSelection\fR. \fIPortion\fR will be a pointer to
@@ -69,9 +71,10 @@ been completely retrieved and processed by \fIproc\fR, or when a
fatal error has occurred (e.g. the selection owner did not respond
promptly). \fBTk_GetSelection\fR normally returns \fBTCL_OK\fR; if
an error occurs, it returns \fBTCL_ERROR\fR and leaves an error message
-in \fIinterp->result\fR. \fIProc\fR should also return either
-\fBTCL_OK\fR or \fBTCL_ERROR\fR. If \fIproc\fR encounters an error in dealing with the
-selection, it should leave an error message in \fIinterp->result\fR
-and return \fBTCL_ERROR\fR; this will abort the selection retrieval.
+in interpreter \fIinterp\fR's result. \fIProc\fR should also return either
+\fBTCL_OK\fR or \fBTCL_ERROR\fR. If \fIproc\fR encounters an error in
+dealing with the selection, it should leave an error message in the
+interpreter result and return \fBTCL_ERROR\fR; this will abort the
+selection retrieval.
.SH KEYWORDS
format, get, selection retrieval