## Tcl8.6.17/Tk8.6.17 Documentation > Tcl Commands > catch

### Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

### NAME

catch — 記述譜を評価し､例外戻りを捕捉する Evaluate script and trap exceptional returns

### 構文 SYNOPSIS

catch script ?resultVarName? ?optionsVarName?

### 説明 DESCRIPTION

この catch 命令は命令の解釈実行機能の異常終了から不都合を抑制することにも使用できる｡ catch 命令は記述譜を実行する為に再帰的に Tcl 解釈実行機能を呼出し､そして､記述譜を実行している間にどの様な不都合が生じても､常に､不都合なしで戻る｡ 　　　 The catch command may be used to prevent errors from aborting command interpretation. The catch command calls the Tcl interpreter recursively to execute script, and always returns without raising an error, regardless of any errors that might occur while executing script.

もし､記述譜 script が不都合を生じると､ catch は､記述譜 script の評価により､例外戻り番号に相当する非零の整数値を返す｡Tcl は記述譜評価の正常戻りに零(0)､と TCL_OK を定義している｡又､Tclは４つの例外戻り番号を定義している: 1 (TCL_ERROR), 2 (TCL_RETURN), 3 (TCL_BREAK), 4 (TCL_CONTINUE) である｡ 記述譜を評価している間の不都合は TCL_ERROR の戻り番号で指し示される｡それ以外の例外番号は､説明書の通りの特別な状態から return と break と continue 命令によって戻される｡Tcl 梱包は､これ以外の整数を同じ様に戻す新しい命令を定義することも可能である､又､定められている五つ以外の戻り番号を有する return -code 命令を使う記述譜を作ることも可能である｡ 　　　 If script raises an error, catch will return a non-zero integer value corresponding to the exceptional return code returned by evaluation of script. Tcl defines the normal return code from script evaluation to be zero (0), or TCL_OK. Tcl also defines four exceptional return codes: 1 (TCL_ERROR), 2 (TCL_RETURN), 3 (TCL_BREAK), and 4 (TCL_CONTINUE). Errors during evaluation of a script are indicated by a return code of TCL_ERROR. The other exceptional return codes are returned by the return, break, and continue commands and in other special situations as documented. Tcl packages can define new commands that return other integer values as return codes as well, and scripts that make use of the return -code command can also have return codes other than the five defined by Tcl.

もし resultVarName 引数が与えられると､この値の名前は記述譜の評価の結果として設定される｡記述譜の戻り番号が1(TCL_ERROR)であると､resultVarName には不都合情報が保存される｡記述譜の戻り番号が0(TCL_OK)であると､ resultVarName に保存された値は､記述譜 script から戻った値である｡ 　　 If the resultVarName argument is given, then the variable it names is set to the result of the script evaluation. When the return code from the script is 1 (TCL_ERROR), the value stored in resultVarName is an error message. When the return code from the script is 0 (TCL_OK), the value stored in resultVarName is the value returned from script.

もし optionsVarName 引数が与えられると､その名前が付けられた変数が､記述譜の評価によって返された選択戻りの辞書に設定される｡Tcl は二つの見出しを指定する､それは､常に､辞書中に定義された: -code と -level である｡記述譜の評価からの戻り番号が TCL_RETURN ではない場合､ -level 見出しの値は0になり､-code 見出しの値は戻り番号に等しくなる｡戻り番号が TCL_RETURN のときのみ､ -level と -code 見出しの値はそれ以外になるが､更なる詳細は return 命令の説明を参照されたい｡ 　　　 If the optionsVarName argument is given, then the variable it names is set to a dictionary of return options returned by evaluation of script. Tcl specifies two entries that are always defined in the dictionary: -code and -level. When the return code from evaluation of script is not TCL_RETURN, the value of the -level entry will be 0, and the value of the -code entry will be the same as the return code. Only when the return code is TCL_RETURN will the values of the -level and -code entries be something else, as further described in the documentation for the return command.

記述譜 script の戻り番号が TCL_ERROR の時には､ optionsVarName に保存される戻り選択辞書内に四つの追加見出しが定義される: -errorinfo と -errorcode と -errorline と -errorstack ｡ 見出し -errorinfo の値は､書式化された棚追跡で不都合が生じた文脈について更なる情報を含んでいる｡書式化された棚追跡とは､可読化されているとの意味である｡-errorcode 見出しの値はリストとして保存された不都合に関する追加情報である｡ -errorcode の値は､算譜によって更に処理する為のものであり､可読化はされていない｡ -errorline 見出しの値は整数であって､不都合が生じた時に評価されていた記述譜 script の行を指し示す｡見出し -errorstack の値は解析字句-假引数対による偶数寸法のリストで棚の巻き戻しの際に累積されたものである｡字句は “CALL”かもしれず､その場合の假引数は対応する水準の手続函数の名前と引数で作成されたリストである; “UP” かもしれず､その場合の假引数は以前の CALL の相対的水準(uplevel の様な)である｡ -errorinfo との顕著な差異は:

1. [foreach {tok prm} ...]による処理に適した機械可読の形式である､

2. 呼出し側の静的文書ではなく函数に渡された真の値(代入された)を含んでいる､そして

3. 棚枠毎に唯一つの要素を伴うだけの粗引きのものである(手続函数の様に; 譬えば foreach 構造用の区切りなし要素)｡

When the return code from evaluation of script is TCL_ERROR, four additional entries are defined in the dictionary of return options stored in optionsVarName: -errorinfo, -errorcode, -errorline, and -errorstack. The value of the -errorinfo entry is a formatted stack trace containing more information about the context in which the error happened. The formatted stack trace is meant to be read by a person. The value of the -errorcode entry is additional information about the error stored as a list. The -errorcode value is meant to be further processed by programs, and may not be particularly readable by people. The value of the -errorline entry is an integer indicating which line of script was being evaluated when the error occurred. The value of the -errorstack entry is an even-sized list made of token-parameter pairs accumulated while unwinding the stack. The token may be “CALL”, in which case the parameter is a list made of the proc name and arguments at the corresponding level; or it may be “UP”, in which case the parameter is the relative level (as in uplevel) of the previous CALL. The salient differences with respect to -errorinfo are that:

1. it is a machine-readable form that is amenable to processing with [foreach {tok prm} ...],

2. it contains the true (substituted) values passed to the functions, instead of the static text of the calling sites, and

3. it is coarser-grained, with only one element per stack frame (like procs; no separate elements for foreach constructs for example).

最も最近の不都合の -errorinfo と -errorcode 見出しの値もそれぞれ大域変数 ::errorInfo と ::errorCode の値として利用できる｡ -errorstack 見出しの値は info errorstack として覆っている｡ 　　　 The values of the -errorinfo and -errorcode entries of the most recent error are also available as values of the global variables ::errorInfo and ::errorCode respectively. The value of the -errorstack entry surfaces as info errorstack.

Tcl 梱包は戻り選択辞書にその他の見出しを設定する命令をもたらし､ return 命令は記述譜によって上で定義されたように選択戻りの設定に使用できる｡ 　　　 Tcl packages may provide commands that set other entries in the dictionary of return options, and the return command may be used by scripts to set return options in addition to those defined above.

### 用例 EXAMPLES

この catch 命令は if の中で記述譜が成功したか否かで枝分かれする様にも使われる｡ 　　 The catch command may be used in an if to branch based on the success of a script.

    if { [catch {open $someFile w} fid] } {
        puts stderr "Could not open $someFile for writing\n$fid"
        exit 1
    }

return 命令の説明の箇所に catch を使う高度な使用例がある｡ 　　　 There are more complex examples of catch usage in the documentation for the return command.

### SEE ALSO

break, continue, dict, error, errorCode, errorInfo, info, return

### KEYWORDS

catch, error, exception
Copyright © 1993-1994 The Regents of the University of California.
Copyright © 1994-1996 Sun Microsystems, Inc.