{"id":6648,"date":"2022-12-20T19:19:34","date_gmt":"2022-12-20T22:19:34","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/tcl_cancel-man3\/"},"modified":"2022-12-20T19:19:34","modified_gmt":"2022-12-20T22:19:34","slug":"tcl_cancel-man3","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/tcl_cancel-man3\/","title":{"rendered":"Tcl_Cancel (man3)"},"content":{"rendered":"<h1 align=\"center\">Tcl_Cancel<\/h1>\n<p> <a href=\"#NAME\">NAME<\/a><br \/> <a href=\"#SYNOPSIS\">SYNOPSIS<\/a><br \/> <a href=\"#ARGUMENTS\">ARGUMENTS<\/a><br \/> <a href=\"#DESCRIPTION\">DESCRIPTION<\/a><br \/> <a href=\"#SEE ALSO\">SEE ALSO<\/a><br \/> <a href=\"#KEYWORDS\">KEYWORDS<\/a> <\/p>\n<hr>\n<p>______________________________________________________________________________<\/p>\n<h2>NAME <a name=\"NAME\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\">Tcl_CancelEval, Tcl_Canceled \u2212 cancel Tcl scripts<\/p>\n<h2>SYNOPSIS <a name=\"SYNOPSIS\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><b>#include <tcl.h><\/b> <br \/> int <b><br \/> Tcl_CancelEval<\/b>(<i>interp, resultObjPtr, clientData, flags<\/i>)<\/p>\n<p style=\"margin-left:11%; margin-top: 1em\">int <b><br \/> Tcl_Canceled<\/b>(<i>interp, flags<\/i>)<\/p>\n<h2>ARGUMENTS <a name=\"ARGUMENTS\"><\/a> <\/h2>\n<table width=\"100%\" border=\"0\" rules=\"none\" frame=\"void\" cellspacing=\"0\" cellpadding=\"0\">\n<tr valign=\"top\" align=\"left\">\n<td width=\"11%\"><\/td>\n<td width=\"40%\">\n<p style=\"margin-top: 1em\">Tcl_Interp <i>*interp<\/i> (in)<\/p>\n<\/td>\n<td width=\"11%\"><\/td>\n<td width=\"38%\">\n<p style=\"margin-top: 1em\">Interpreter in which to cancel the script.<\/p>\n<\/td>\n<\/tr>\n<tr valign=\"top\" align=\"left\">\n<td width=\"11%\"><\/td>\n<td width=\"40%\">\n<p>Tcl_Obj <i>*resultObjPtr<\/i> (in)<\/p>\n<\/td>\n<td width=\"11%\"><\/td>\n<td width=\"38%\">\n<p>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 <b>Tcl_CancelEval<\/b> returns.<\/p>\n<\/td>\n<\/tr>\n<tr valign=\"top\" align=\"left\">\n<td width=\"11%\"><\/td>\n<td width=\"40%\">\n<p>int <i>flags<\/i> (in)<\/p>\n<\/td>\n<td width=\"11%\"><\/td>\n<td width=\"38%\">\n<p>ORed combination of flag bits that specify additional options. For <b>Tcl_CancelEval<\/b>, only <b>TCL_CANCEL_UNWIND<\/b> is currently supported. For <b>Tcl_Canceled<\/b>, only <b>TCL_LEAVE_ERR_MSG<\/b> and <b>TCL_CANCEL_UNWIND<\/b> are currently supported.<\/p>\n<\/td>\n<\/tr>\n<tr valign=\"top\" align=\"left\">\n<td width=\"11%\"><\/td>\n<td width=\"40%\">\n<p>ClientData <i>clientData<\/i> (in)<\/p>\n<\/td>\n<td width=\"11%\"><\/td>\n<td width=\"38%\">\n<p>Currently reserved for future use. It should be set to NULL.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n<p style=\"margin-left:62%;\">______________________________________________________________________________<\/p>\n<h2>DESCRIPTION <a name=\"DESCRIPTION\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><b>Tcl_CancelEval<\/b> cancels or unwinds the script in progress soon after the next invocation of asynchronous handlers, causing <b>TCL_ERROR<\/b> to be the return code for that script. This function is thread-safe and may be called from any thread in the process.<\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><b>Tcl_Canceled<\/b> checks if the script in progress has been canceled and returns <b>TCL_ERROR<\/b> if it has. Otherwise, <b>TCL_OK<\/b> 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.<\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><b>FLAG BITS<\/b> <br \/> Any ORed combination of the following values may be used for the <i>flags<\/i> argument to procedures such as <b>Tcl_CancelEval<\/b>:<\/p>\n<table width=\"100%\" border=\"0\" rules=\"none\" frame=\"void\" cellspacing=\"0\" cellpadding=\"0\">\n<tr valign=\"top\" align=\"left\">\n<td width=\"11%\"><\/td>\n<td width=\"26%\">\n<p style=\"margin-top: 1em\"><b>TCL_CANCEL_UNWIND<\/b><\/p>\n<\/td>\n<td width=\"5%\"><\/td>\n<td width=\"58%\">\n<p style=\"margin-top: 1em\">This flag is used by <b>Tcl_CancelEval<\/b> and <b>Tcl_Canceled<\/b>. For <b>Tcl_CancelEval<\/b>, if this flag is set, the script in progress is canceled and the evaluation stack for the interpreter is unwound. For <b>Tcl_Canceled<\/b>, 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.<\/p>\n<\/td>\n<\/tr>\n<tr valign=\"top\" align=\"left\">\n<td width=\"11%\"><\/td>\n<td width=\"26%\">\n<p><b>TCL_LEAVE_ERR_MSG<\/b><\/p>\n<\/td>\n<td width=\"5%\"><\/td>\n<td width=\"58%\">\n<p>This flag is only used by <b>Tcl_Canceled<\/b>; it is ignored by other procedures. If an error is returned and this bit is set in <i>flags<\/i>, then an error message will be left in the interpreter\u2019s result, where it can be retrieved with <b>Tcl_GetObjResult<\/b> or <b>Tcl_GetStringResult<\/b>. If this flag bit is not set then no error message is left and the interpreter\u2019s result will not be modified.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n<h2>SEE ALSO <a name=\"SEE ALSO\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\">interp(n), Tcl_Eval(3), TIP 285<\/p>\n<h2>KEYWORDS <a name=\"KEYWORDS\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\">cancel, unwind<\/p>\n<hr>\n","protected":false},"excerpt":{"rendered":"<p>  Tcl_CancelEval, Tcl_Canceled \u2212 cancel Tcl scripts <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2536],"tags":[2538,3007,3028],"class_list":["post-6648","post","type-post","status-publish","format-standard","hentry","category-3-llamadas-de-bibliotecas","tag-2538","tag-man3","tag-tcl_canceleval"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6648","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=6648"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6648\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=6648"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=6648"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=6648"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}