home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / BackgdErr.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.3 KB  |  58 lines
  1. '\"
  2. '\" Copyright (c) 1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/BackgdErr.3,v 1.3 93/04/01 09:41:07 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_BackgroundError tkc
  25. .BS
  26. .SH NAME
  27. Tk_BackgroundError \- report Tcl error that occurred in background processing
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. \fBTk_BackgroundError\fR(\fIinterp\fR)
  33. .SH ARGUMENTS
  34. .AS Tcl_Interp *interp
  35. .AP Tcl_Interp *interp in
  36. Interpreter in which the error occurred.
  37. .BE
  38.  
  39. .SH DESCRIPTION
  40. .PP
  41. This procedure is typically invoked when a Tcl error occurs during
  42. ``background processing'' such as executing a Tcl command in response
  43. to a button press or menu entry invocation.
  44. When such an error occurs, the error condition is reported to Tk
  45. or to a widget or some other C code, and there is not usually any
  46. obvious way for that code to report the error to the user.
  47. In these cases the code calls \fBTk_BackgroundError\fR with an
  48. \fIinterp\fR argument identifying the interpreter in which the
  49. error occurred.
  50. \fBTk_BackgroundError\fR attempts to invoke the \fBtkerror\fR
  51. Tcl command to report the error in an application-specific fashion.
  52. If no \fBtkerror\fR command exists, or if it returns with an error condition,
  53. then \fBTk_BackgroundError\fR reports the error itself by printing
  54. a message on the standard error file.
  55.  
  56. .SH KEYWORDS
  57. background, error, tkerror
  58.