File: tcllib_throw.man

package info (click to toggle)
tcllib 1.20%2Bdfsg-1
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 68,064 kB
  • sloc: tcl: 216,842; ansic: 14,250; sh: 2,846; xml: 1,766; yacc: 1,145; pascal: 881; makefile: 107; perl: 84; f90: 84; python: 33; ruby: 13; php: 11
file content (40 lines) | stat: -rw-r--r-- 1,163 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
[comment {-*- tcl -*- doctools manpage}]
[vset VERSION 1]
[manpage_begin throw n [vset VERSION]]
[see_also error(n)]
[keywords error]
[keywords throw]
[keywords return]

[copyright {2015 Miguel Martínez López, BSD licensed}]
[moddesc {Forward compatibility implementation of [throw]}]
[titledesc {throw - Throw an error exception with a message}]
[category  Utility]
[require Tcl 8.5]
[require throw [opt [vset VERSION]]]
[description]
[para]

This package provides a forward-compatibility implementation of Tcl
8.6's throw command (TIP 329), for Tcl 8.5. The code was
directly pulled from Tcl 8.6 revision ?, when try/finally was
implemented as Tcl procedure instead of in C.

[list_begin definitions]
[comment {- - -- --- ----- -------- ------------- ---------------------}]
[call [cmd ::throw] [arg error_code] [arg error_message]]

throw is merely a reordering of the arguments of the error command. It throws an error with the indicated 
error code and error message.

[list_end]

[section EXAMPLES]

[para][example_begin]
[cmd throw] {MYERROR CODE} "My error message"
[example_end]

[vset CATEGORY try]
[include ../common-text/feedback.inc]
[manpage_end]