error.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:2k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1993 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '"
  5. '" See the file "license.terms" for information on usage and redistribution
  6. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '" 
  8. '" RCS: @(#) $Id: error.n,v 1.3.18.1 2004/10/27 09:35:38 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH error n "" Tcl "Tcl Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. error - Generate an error
  16. .SH SYNOPSIS
  17. fBerror fImessagefR ?fIinfofR? ?fIcodefR?
  18. .BE
  19. .SH DESCRIPTION
  20. .PP
  21. Returns a fBTCL_ERRORfR code, which causes command interpretation to be
  22. unwound.  fIMessagefR is a string that is returned to the application
  23. to indicate what went wrong.
  24. .PP
  25. If the fIinfofR argument is provided and is non-empty,
  26. it is used to initialize the global variable fBerrorInfofR.
  27. fBerrorInfofR is used to accumulate a stack trace of what
  28. was in progress when an error occurred; as nested commands unwind,
  29. the Tcl interpreter adds information to fBerrorInfofR.  If the
  30. fIinfofR argument is present, it is used to initialize
  31. fBerrorInfofR and the first increment of unwind information
  32. will not be added by the Tcl interpreter.  In other
  33. words, the command containing the fBerrorfR command will not appear
  34. in fBerrorInfofR; in its place will be fIinfofR.
  35. This feature is most useful in conjunction with the fBcatchfR command:
  36. if a caught error cannot be handled successfully, fIinfofR can be used
  37. to return a stack trace reflecting the original point of occurrence
  38. of the error:
  39. .CS
  40. fBcatch {...} errMsg
  41. set savedInfo $errorInfo
  42. &...
  43. error $errMsg $savedInfofR
  44. .CE
  45. .PP
  46. If the fIcodefR argument is present, then its value is stored
  47. in the fBerrorCodefR global variable.  This variable is intended
  48. to hold a machine-readable description of the error in cases where
  49. such information is available; see the fBtclvarsfR manual
  50. page for information on the proper format for the variable.
  51. If the fIcodefR argument is not
  52. present, then fBerrorCodefR is automatically reset to
  53. ``NONE'' by the Tcl interpreter as part of processing the
  54. error generated by the command.
  55. .SH EXAMPLE
  56. Generate an error if a basic mathematical operation fails:
  57. .CS
  58. if {1+2 != 3} {
  59.     fBerrorfR "something is very wrong with addition"
  60. }
  61. .CE
  62. .SH "SEE ALSO"
  63. catch(n), return(n), tclvars(n)
  64. .SH KEYWORDS
  65. error, errorCode, errorInfo