{"id":6710,"date":"2022-12-20T19:33:28","date_gmt":"2022-12-20T22:33:28","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/tcl_booleanobj-man3-2\/"},"modified":"2022-12-20T19:33:28","modified_gmt":"2022-12-20T22:33:28","slug":"tcl_booleanobj-man3-2","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/tcl_booleanobj-man3-2\/","title":{"rendered":"Tcl_BooleanObj (man3)"},"content":{"rendered":"

Tcl_BooleanObj<\/h1>\n

NAME<\/a>
SYNOPSIS<\/a>
ARGUMENTS<\/a>
DESCRIPTION<\/a>
SEE ALSO<\/a>
KEYWORDS<\/a> <\/p>\n

\n

______________________________________________________________________________<\/p>\n

NAME <\/a> <\/h2>\n

Tcl_NewBooleanObj, Tcl_SetBooleanObj, Tcl_GetBooleanFromObj \u2212 store\/retrieve boolean value in a Tcl_Obj<\/p>\n

SYNOPSIS <\/a> <\/h2>\n

#include <\/b><\/p>\n

Tcl_Obj bodies manpages.csv script_extrae_body.sh script.sh usr
Tcl_NewBooleanObj<\/b>(boolValue<\/i>)<\/p>\n

Tcl_SetBooleanObj<\/b>(objPtr, boolValue<\/i>)<\/p>\n

int
Tcl_GetBooleanFromObj<\/b>(interp, objPtr, boolPtr<\/i>)<\/p>\n

ARGUMENTS <\/a> <\/h2>\n\n\n\n\n\n
<\/td>\n\n

int boolValue<\/i> (in)<\/p>\n<\/td>\n

<\/td>\n\n

Integer value to be stored as a boolean value in a Tcl_Obj.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

Tcl_Obj *objPtr<\/i> (in\/out)<\/p>\n<\/td>\n

<\/td>\n\n

Points to the Tcl_Obj in which to store, or from which to retrieve a boolean value.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

Tcl_Interp *interp<\/i> (in\/out)<\/p>\n<\/td>\n

<\/td>\n\n

If a boolean value cannot be retrieved, an error message is left in the interpreter\u2019s result value unless interp<\/i> is NULL.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

int *boolPtr<\/i> (out)<\/p>\n<\/td>\n

<\/td>\n\n

Points to place where Tcl_GetBooleanFromObj<\/b> stores the boolean value (0 or 1) obtained from objPtr<\/i>.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

______________________________________________________________________________<\/p>\n

DESCRIPTION <\/a> <\/h2>\n

These procedures are used to pass boolean values to and from Tcl as Tcl_Obj\u2019s. When storing a boolean value into a Tcl_Obj, any non-zero integer value in boolValue<\/i> is taken to be the boolean value 1<\/b>, and the integer value 0<\/b> is taken to be the boolean value 0<\/b>.<\/p>\n

Tcl_NewBooleanObj<\/b> creates a new Tcl_Obj, stores the boolean value boolValue<\/i> in it, and returns a pointer to the new Tcl_Obj. The new Tcl_Obj has reference count of zero.<\/p>\n

Tcl_SetBooleanObj<\/b> accepts objPtr<\/i>, a pointer to an existing Tcl_Obj, and stores in the Tcl_Obj *objPtr<\/i> the boolean value boolValue<\/i>. This is a write operation on *objPtr<\/i>, so objPtr<\/i> must be unshared. Attempts to write to a shared Tcl_Obj will panic. A successful write of boolValue<\/i> into *objPtr<\/i> implies the freeing of any former value stored in *objPtr<\/i>.<\/p>\n

Tcl_GetBooleanFromObj<\/b> attempts to retrieve a boolean value from the value stored in *objPtr<\/i>. If objPtr<\/i> holds a string value recognized by Tcl_GetBoolean<\/b>, then the recognized boolean value is written at the address given by boolPtr<\/i>. If objPtr<\/i> holds any value recognized as a number by Tcl, then if that value is zero a 0 is written at the address given by boolPtr<\/i> and if that value is non-zero a 1 is written at the address given by boolPtr<\/i>. In all cases where a value is written at the address given by boolPtr<\/i>, Tcl_GetBooleanFromObj<\/b> returns TCL_OK<\/b>. If the value of objPtr<\/i> does not meet any of the conditions above, then TCL_ERROR<\/b> is returned and an error message is left in the interpreter\u2019s result unless interp<\/i> is NULL. Tcl_GetBooleanFromObj<\/b> may also make changes to the internal fields of *objPtr<\/i> so that future calls to Tcl_GetBooleanFromObj<\/b> on the same objPtr<\/i> can be performed more efficiently.<\/p>\n

Note that the routines Tcl_GetBooleanFromObj<\/b> and Tcl_GetBoolean<\/b> are not functional equivalents. The set of values for which Tcl_GetBooleanFromObj<\/b> will return TCL_OK<\/b> is strictly larger than the set of values for which Tcl_GetBoolean<\/b> will do the same. For example, the value \u201c5\u201d passed to Tcl_GetBooleanFromObj<\/b> will lead to a TCL_OK<\/b> return (and the boolean value 1), while the same value passed to Tcl_GetBoolean<\/b> will lead to a TCL_ERROR<\/b> return.<\/p>\n

SEE ALSO <\/a> <\/h2>\n

Tcl_NewObj, Tcl_IsShared, Tcl_GetBoolean<\/p>\n

KEYWORDS <\/a> <\/h2>\n

boolean, value<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

Tcl_NewBooleanObj, Tcl_SetBooleanObj, Tcl_GetBooleanFromObj \u2212 store\/retrieve boolean value in a Tcl_Obj <\/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,3086],"class_list":["post-6710","post","type-post","status-publish","format-standard","hentry","category-3-llamadas-de-bibliotecas","tag-2538","tag-man3","tag-tcl_newbooleanobj"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6710","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=6710"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6710\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=6710"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=6710"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=6710"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}