## Tcl8.6.17/Tk8.6.17 Documentation > Tcl C API > Cancel

### 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
    Tcl_CancelEval, Tcl_Canceled — Tcl 記述譜を取り消す　cancel Tcl scripts
  SYNOPSIS
    #include <tcl.h>
    int
    Tcl_CancelEval(interp, resultObjPtr, clientData, flags)
    int
    Tcl_Canceled(interp, flags)
  引数 ARGUMENTS
    Tcl_Interp *interp (入力in)
    Tcl_Obj *resultObjPtr (入力in)
    int flags (入力in)
    ClientData clientData (入力in)
  説明 DESCRIPTION
  FLAG BITS
    TCL_CANCEL_UNWIND
    TCL_LEAVE_ERR_MSG
  SEE ALSO
  KEYWORDS

### NAME

Tcl_CancelEval, Tcl_Canceled — Tcl 記述譜を取り消す　cancel Tcl scripts

### SYNOPSIS

#include <tcl.h>
int
Tcl_CancelEval(interp, resultObjPtr, clientData, flags)
int
Tcl_Canceled(interp, flags)

### 引数 ARGUMENTS

Tcl_Interp *interp (入力in)
  その中で記述譜を無効にする解釈実行機能｡ 　 Interpreter in which to cancel the script.

Tcl_Obj *resultObjPtr (入力in)
  無効化の中で使用する不都合伝言文､又は省略時伝言文用の NULL ｡もし NULL の場合､この対象は Tcl_CancelEval から帰る前にその参照勘定を減らさせる｡ 　　　 Error message to use in the cancellation, or NULL to use a default message. If not NULL, this object will have its reference count decremented before Tcl_CancelEval returns.

int flags (入力in)
  ビットの論理和の組合せで追加の指定項目を指示する旗印｡ Tcl_CancelEval 用には現在 TCL_CANCEL_UNWIND のみを運営している｡又､ Tcl_Canceled 用には現在 TCL_LEAVE_ERR_MSG と TCL_CANCEL_UNWIND のみが運営されている｡ OR'ed combination of flag bits that specify additional options. For Tcl_CancelEval, only TCL_CANCEL_UNWIND is currently supported. For Tcl_Canceled, only TCL_LEAVE_ERR_MSG and TCL_CANCEL_UNWIND are currently supported.

ClientData clientData (入力in)
  現在の処､将来の為に予約されている｡NULLに設定されるべきである｡ Currently reserved for future use. It should be set to NULL.

### 説明 DESCRIPTION

Tcl_CancelEval は次の非同期の処理機能の後､処理中の記述譜を無効にするか戻すかしてその記述譜に関して TCL_ERROR 返りを惹き起こさせる｡この函数は時分割に対して安全であり､処理中のどの時分割片からも呼出せる｡ Tcl_CancelEval cancels or unwinds the script in progress soon after the next invocation of asynchronous handlers, causing TCL_ERROR to be the return code for that script. This function is thread-safe and may be called from any thread in the process.

Tcl_Canceled は処理中の記述譜が無効にされたかを検査し､そうであれば TCL_ERROR を返す｡それ以外の場合 TCL_OK が返される｡拡張はこの函数が長期実行命令を中断するかを検査するために使用できる｡この函数は時分割多重に感応的であり､この解釈実行機能が生成された時分割片からのみ呼出せる｡ Tcl_Canceled checks if the script in progress has been canceled and returns TCL_ERROR if it has. Otherwise, TCL_OK is returned. Extensions can use this function to check to see if they should abort a long running command. This function is thread sensitive and may only be called from the thread the interpreter was created in.

#### FLAG BITS

次の値のどの論理和の組み合せも Tcl_CancelEval の様な手続函数への flags 引数として使用できる: Any OR'ed combination of the following values may be used for the flags argument to procedures such as Tcl_CancelEval:

TCL_CANCEL_UNWIND
  この旗印は Tcl_CancelEval と Tcl_Canceled に使用される｡ Tcl_CancelEval に就いて､もしこの旗印が設定されていると､処理中の記述譜は無効化され､解釈実行機能に就いての評価棚は巻き戻されない｡ Tcl_Canceled について､もしこの旗印が設定されている場合､解釈実行機能についての評価棚が巻き戻されている場合にのみ､処理中の記述譜が無効と看做される｡ 　　　 This flag is used by Tcl_CancelEval and Tcl_Canceled. For Tcl_CancelEval, if this flag is set, the script in progress is canceled and the evaluation stack for the interpreter is unwound. For Tcl_Canceled, if this flag is set, the script in progress is considered to be canceled only if the evaluation stack for the interpreter is being unwound.

TCL_LEAVE_ERR_MSG
  この旗印は Tcl_Canceled にのみ使用され他の手続き函数では無視される｡もし不都合が返され且つこのビットが flags 内に設定されている場合､不都合伝言文は解釈実行機能の結果に残される､又､それは Tcl_GetObjResult か Tcl_GetStringResult によって取り返し得る｡もしこの旗印が設定されていない場合､不都合伝言文は残されず､解釈実行機能の結果は修正される事はない｡ 　　 This flag is only used by Tcl_Canceled; it is ignored by other procedures. If an error is returned and this bit is set in flags, then an error message will be left in the interpreter's result, where it can be retrieved with Tcl_GetObjResult or Tcl_GetStringResult. If this flag bit is not set then no error message is left and the interpreter's result will not be modified.

### SEE ALSO

interp, Tcl_Eval, TIP 285

### KEYWORDS

cancel, unwind
Copyright © 2006-2008 Joe Mistachkin.