diff options
author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2011-08-14 08:23:53 (GMT) |
---|---|---|
committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2011-08-14 08:23:53 (GMT) |
commit | 927ddd336a7df009926978b4a107d8c37a53cdeb (patch) | |
tree | bb84ca16b8b76a5599b73bde8b969a767735fe53 /doc/Panic.3 | |
parent | fae17047ec3461d9defd288d7540befdae878f46 (diff) | |
download | tcl-927ddd336a7df009926978b4a107d8c37a53cdeb.zip tcl-927ddd336a7df009926978b4a107d8c37a53cdeb.tar.gz tcl-927ddd336a7df009926978b4a107d8c37a53cdeb.tar.bz2 |
[Patch 3124554]: Move WishPanic from Tk to Tcl
Added Documentation
Diffstat (limited to 'doc/Panic.3')
-rw-r--r-- | doc/Panic.3 | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/doc/Panic.3 b/doc/Panic.3 index 44eb102..48aed2b 100644 --- a/doc/Panic.3 +++ b/doc/Panic.3 @@ -49,7 +49,10 @@ same formatting rules are also used by the built-in Tcl command In a freshly loaded Tcl library, \fBTcl_Panic\fR prints the formatted error message to the standard error file of the process, and then calls \fBabort\fR to terminate the process. \fBTcl_Panic\fR does not -return. +return. On Windows, when a debugger is running, the formatted error +message is sent to the debugger in stead. If the windows executable +does not have a stderr channel (e.g. \fBwish.exe\fR), then a +system dialog box is used to display the panic message. .PP \fBTcl_SetPanicProc\fR may be used to modify the behavior of \fBTcl_Panic\fR. The \fIpanicProc\fR argument should match the @@ -63,19 +66,14 @@ typedef void \fBTcl_PanicProc\fR( .PP After \fBTcl_SetPanicProc\fR returns, any future calls to \fBTcl_Panic\fR will call \fIpanicProc\fR, passing along the -\fIformat\fR and \fIarg\fR arguments. To maintain consistency with the -callers of \fBTcl_Panic\fR, \fIpanicProc\fR must not return; it must -call \fBabort\fR. \fIpanicProc\fR should avoid making calls into the -Tcl library, or into other libraries that may call the Tcl library, -since the original call to \fBTcl_Panic\fR indicates the Tcl library is -not in a state of reliable operation. +\fIformat\fR and \fIarg\fR arguments. \fIpanicProc\fR should avoid +making calls into the Tcl library, or into other libraries that may +call the Tcl library, since the original call to \fBTcl_Panic\fR +indicates the Tcl library is not in a state of reliable operation. .PP The typical use of \fBTcl_SetPanicProc\fR arranges for the error message to be displayed or reported in a manner more suitable for the -application or the platform. As an example, the Windows implementation -of \fBwish\fR calls \fBTcl_SetPanicProc\fR to force all panic messages -to be displayed in a system dialog box, rather than to be printed to the -standard error file (usually not visible under Windows). +application or the platform. .PP Although the primary callers of \fBTcl_Panic\fR are the procedures of the Tcl library, \fBTcl_Panic\fR is a public function and may be called |