## Tcl9.0.3/Tk9.0.3 Documentation > Tcl C API > SetVar

### 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_SetVar2Ex, Tcl_SetVar, Tcl_SetVar2, Tcl_ObjSetVar2, Tcl_GetVar2Ex, Tcl_GetVar, Tcl_GetVar2, Tcl_ObjGetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 — Tcl 変数を操作する manipulate Tcl variables
  SYNOPSIS
    #include <tcl.h>
    Tcl_Obj *
    Tcl_SetVar2Ex(interp, name1, name2, newValuePtr, flags)
    const char *
    Tcl_SetVar(interp, varName, newValue, flags)
    const char *
    Tcl_SetVar2(interp, name1, name2, newValue, flags)
    Tcl_Obj *
    Tcl_ObjSetVar2(interp, part1Ptr, part2Ptr, newValuePtr, flags)
    Tcl_Obj *
    Tcl_GetVar2Ex(interp, name1, name2, flags)
    const char *
    Tcl_GetVar(interp, varName, flags)
    const char *
    Tcl_GetVar2(interp, name1, name2, flags)
    Tcl_Obj *
    Tcl_ObjGetVar2(interp, part1Ptr, part2Ptr, flags)
    int
    Tcl_UnsetVar(interp, varName, flags)
    int
    Tcl_UnsetVar2(interp, name1, name2, flags)
  引数 ARGUMENTS
    Tcl_Interp *interp (入力in)
    const char *name1 (入力in)
    const char *name2 (入力in)
    Tcl_Obj *newValuePtr (入力in)
    int flags (入力in)
    const char *varName (入力in)
    const char *newValue (入力in)
    Tcl_Obj *part1Ptr (入力in)
    Tcl_Obj *part2Ptr (入力in)
  説明 DESCRIPTION
    TCL_GLOBAL_ONLY
    TCL_NAMESPACE_ONLY
    TCL_LEAVE_ERR_MSG
    TCL_APPEND_VALUE
    TCL_LIST_ELEMENT
  参照回数管理 REFERENCE COUNT MANAGEMENT
  SEE ALSO
  KEYWORDS

### NAME

Tcl_SetVar2Ex, Tcl_SetVar, Tcl_SetVar2, Tcl_ObjSetVar2, Tcl_GetVar2Ex, Tcl_GetVar, Tcl_GetVar2, Tcl_ObjGetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 — Tcl 変数を操作する manipulate Tcl variables

### SYNOPSIS

#include <tcl.h>
Tcl_Obj *
Tcl_SetVar2Ex(interp, name1, name2, newValuePtr, flags)
const char *
Tcl_SetVar(interp, varName, newValue, flags)
const char *
Tcl_SetVar2(interp, name1, name2, newValue, flags)
Tcl_Obj *
Tcl_ObjSetVar2(interp, part1Ptr, part2Ptr, newValuePtr, flags)
Tcl_Obj *
Tcl_GetVar2Ex(interp, name1, name2, flags)
const char *
Tcl_GetVar(interp, varName, flags)
const char *
Tcl_GetVar2(interp, name1, name2, flags)
Tcl_Obj *
Tcl_ObjGetVar2(interp, part1Ptr, part2Ptr, flags)
int
Tcl_UnsetVar(interp, varName, flags)
int
Tcl_UnsetVar2(interp, name1, name2, flags)

### 引数 ARGUMENTS

Tcl_Interp *interp (入力in)
  変数を含む解釈実行機能｡　 Interpreter containing variable.

const char *name1 (入力in)
  配列変数 ( name2 が非-NULL)の名前を含むか､(name2 が NULL の場合)スカラー変数の名前か変数名と添え字の両方のどちらかである｡特定の名前空間内の変数を指し示す :: 名前空間 修飾子を含むこともある｡　 Contains the name of an array variable (if name2 is non-NULL) or (if name2 is NULL) either the name of a scalar variable or a complete name including both variable name and index. May include :: namespace qualifiers to specify a variable in a particular namespace.

const char *name2 (入力in)
  もし､非-NULL の場合､配列内部の要素の名前を与える; この場合､name1 は配列変数を参照しなければならない｡ If non-NULL, gives name of element within array; in this case name1 must refer to an array variable.

Tcl_Obj *newValuePtr (入力in)
  変数の為の新しい値を含む Tcl 値を指す｡　 Points to a Tcl value containing the new value for the variable.

int flags (入力in)
  追加の情報を提供するビットの論理和組合わせ｡適正な値については下を参照されたい｡　 OR-ed combination of bits providing additional information. See below for valid values.

const char *varName (入力in)
  変数の名前｡特定の名前空間内の変数を指し示す :: 名前空間 修飾子を含むこともある｡スカラー変数又は配列の要素を参照できる｡　　 Name of variable. May include :: namespace qualifiers to specify a variable in a particular namespace. May refer to a scalar variable or an element of an array.

const char *newValue (入力in)
  変数の為の新しい値､非零終端文字列として指定する｡この値の複写は変数内に保存される｡　 New value for variable, specified as a null-terminated string. A copy of this value is stored in the variable.

Tcl_Obj *part1Ptr (入力in)
  変数の名前を含む Tcl 値を指す｡その名前は､特定の名前空間内の変数を指し示す :: 名前空間 修飾子の並びを含むこともある｡スカラー変数又は配列の要素を参照できる｡　　 Points to a Tcl value containing the variable's name. The name may include a series of :: namespace qualifiers to specify a variable in a particular namespace. May refer to a scalar variable or an element of an array variable.

Tcl_Obj *part2Ptr (入力in)
  非-NULL の場合､配列内部の要素の名前を含む値を指し､且つ､part1Ptr は「配列変数を参照しなければならない｡　 If non-NULL, points to a value containing the name of an element within an array and part1Ptr must refer to an array variable.

### 説明 DESCRIPTION

これ等の手続は C 命令譜から Tcl 変数を生成､修正､読出し､削除するために使う｡ These procedures are used to create, modify, read, and delete Tcl variables from C code.

Tcl_SetVar2Ex と Tcl_SetVar と Tcl_SetVar2 と Tcl_ObjSetVar2 は新しい変数を生成し､又は既存の変数を修正する｡これらの手続函数は与えられた変数を､ newValuePtr か newValue によって与えられた値に設定し､変数の新しい値へのポインタを返す､それは Tcl の変数構造内に保存される｡Tcl_SetVar2Ex と Tcl_ObjSetVar2 は新しい値を Tcl_Obj として採り､ Tcl_Obj へのポインタを返す｡ Tcl_SetVar と Tcl_SetVar2 は文字列として新しい値を取り､文字列を返す; それは通常 Tcl_ObjSetVar2.よりも非効率である｡註意すべきは返される値は､書込み追跡による修正により､ newValuePtr や newValue 引数とは異なるかもしれない｡もし変数の設定中に不都合が生じると(譬えば､変数配列が配列内への索引が与えられることなく参照されれる)､ NULL が返され､不都合伝言文が､ TCL_LEAVE_ERR_MSG の flag ビットが設定されている場合は､ interp's の結果内に残される｡ Tcl_SetVar2Ex, Tcl_SetVar, Tcl_SetVar2, and Tcl_ObjSetVar2 will create a new variable or modify an existing one. These procedures set the given variable to the value given by newValuePtr or newValue and return a pointer to the variable's new value, which is stored in Tcl's variable structure. Tcl_SetVar2Ex and Tcl_ObjSetVar2 take the new value as a Tcl_Obj and return a pointer to a Tcl_Obj. Tcl_SetVar and Tcl_SetVar2 take the new value as a string and return a string; they are usually less efficient than Tcl_ObjSetVar2. Note that the return value may be different than the newValuePtr or newValue argument, due to modifications made by write traces. If an error occurs in setting the variable (e.g. an array variable is referenced without giving an index into the array) NULL is returned and an error message is left in interp's result if the TCL_LEAVE_ERR_MSG flag bit is set.

Tcl_GetVar2Ex と Tcl_GetVar と Tcl_GetVar2 と Tcl_ObjGetVar2 は変数の現在の値を返す｡これらの手続函数の引数は上に述べられた手続函数への引数と同じ方法で扱われる｡通常の環境下では､返る値は変数値へのポインタである｡ Tcl_GetVar2Ex と Tcl_ObjGetVar2 については値は Tcl_Obj へのポインタとして返される｡ Tcl_GetVar と Tcl_GetVar2 については値は文字列として返される; これは通常非効率的であるので Tcl_GetVar2Ex や Tcl_ObjGetVar2 が好ましい｡もし変数の読込み中に不都合が生じると(譬えば､実在しない変数や配列変数が単純変数として指定された)､ NULL が返され､ TCL_LEAVE_ERR_MSG の flag ビットが設定されている場合は､ interp の結果内に不都合伝言文が残される｡ Tcl_GetVar2Ex, Tcl_GetVar, Tcl_GetVar2, and Tcl_ObjGetVar2 return the current value of a variable. The arguments to these procedures are treated in the same way as the arguments to the procedures described above. Under normal circumstances, the return value is a pointer to the variable's value. For Tcl_GetVar2Ex and Tcl_ObjGetVar2 the value is returned as a pointer to a Tcl_Obj. For Tcl_GetVar and Tcl_GetVar2 the value is returned as a string; this is usually less efficient, so Tcl_GetVar2Ex or Tcl_ObjGetVar2 are preferred. If an error occurs while reading the variable (e.g. the variable does not exist or an array element is specified for a scalar variable), then NULL is returned and an error message is left in interp's result if the TCL_LEAVE_ERR_MSG flag bit is set.

Tcl_UnsetVar と Tcl_UnsetVar2 は､変数の除去に遣われことがあり､その後の変数の読込みの試みは不都合を返すことになる｡これ等の手続への引数は上で述べた手続函数への引数と同じ方法で取扱われる｡もし変数が成功裡に取除かれると TCL_OK が返される｡もし変数が実在しない為に取り除けない場合は TCL_ERROR が返され､ TCL_LEAVE_ERR_MSG の flag ビットが設定されている場合は､不都合伝言文が､ interp の結果内に残される｡もし配列要素が指定されていると与えられた要素は取除かれるが配列は残る｡もし索引なしに配列名が指定されていると配列全体が取去られる｡ Tcl_UnsetVar and Tcl_UnsetVar2 may be used to remove a variable, so that future attempts to read the variable will return an error. The arguments to these procedures are treated in the same way as the arguments to the procedures above. If the variable is successfully removed then TCL_OK is returned. If the variable cannot be removed because it does not exist then TCL_ERROR is returned and an error message is left in interp's result if the TCL_LEAVE_ERR_MSG flag bit is set. If an array element is specified, the given element is removed but the array remains. If an array name is specified without an index, then the entire array is removed.

変数の名前は四つの方法でこれ等の手続函数に指定される: The name of a variable may be specified to these procedures in four ways:

1. もし Tcl_SetVar かTcl_GetVar か Tcl_UnsetVar が起動されると､変数名は一つの文字列 varName として与えられる｡もし varName が左括弧を含み､右括弧で終る場合､括弧の間の値は索引として扱われる(それはどの様な文字列値も有し得る)､又､最初の左括弧の前の文字並びは配列変数の名前として扱われる｡もし varName が上に述べた括弧を有さない場合､文字列全体が単純変数の名前として扱われる｡ If Tcl_SetVar, Tcl_GetVar, or Tcl_UnsetVar is invoked, the variable name is given as a single string, varName. If varName contains an open parenthesis and ends with a close parenthesis, then the value between the parentheses is treated as an index (which can have any string value) and the characters before the first open parenthesis are treated as the name of an array variable. If varName does not have parentheses as described above, then the entire string is treated as the name of a scalar variable.

2. もし､ name1 と name2 引数が与えられ､ name2 が非-NULL の場合､配列要素が指定され､配列名と索引は既に呼出し側によって分けられた: name1 が名前を含み､ name2 が索引を含む｡もし name1 が左括弧を含み右括弧で終わり(配列要素)､且つ name2 が非-NULL の場合､不都合が発生する｡ If the name1 and name2 arguments are provided and name2 is non-NULL, then an array element is specified and the array name and index have already been separated by the caller: name1 contains the name and name2 contains the index. An error is generated if name1 contains an open parenthesis and ends with a close parenthesis (array element) and name2 is non-NULL.

3. もし name2 が NULL の場合 name1 は上の場合 [1] の varName の如く扱われる(単純でも配列要素変数名でも好い)｡ If name2 is NULL, name1 is treated just like varName in case [1] above (it can be either a scalar or an array element variable name).

flags 引数は幾つかの内のどれかの選択肢を手続函数に指定する為に使われる｡それは次のビットの､論理和の組合せで構成される｡ The flags argument may be used to specify any of several options to the procedures. It consists of an OR-ed combination of the following bits.

TCL_GLOBAL_ONLY
  通常の環境下で手続函数は変数を次の様に調べる｡もし手続函数呼出しが解釈実行機能内で活性である場合､変数は手続函数呼出しの現在の水準で調べられる｡それ以外の場合は､変数は最初に現在の名前空間から､次に大域名前空間から調べられる｡しかし､このビットが旗印内に設定されていると､変数はたとえ､活性な手続函数呼出しが存在しても大域名前空間の中のみが調べられる｡もし TCL_GLOBAL_ONLY と TCL_NAMESPACE_ONLY の両方が与えられると TCL_GLOBAL_ONLY は無視される｡ Under normal circumstances the procedures look up variables as follows. If a procedure call is active in interp, the variable is looked up at the current level of procedure call. Otherwise, the variable is looked up first in the current namespace, then in the global namespace. However, if this bit is set in flags then the variable is looked up only in the global namespace even if there is a procedure call active. If both TCL_GLOBAL_ONLY and TCL_NAMESPACE_ONLY are given, TCL_GLOBAL_ONLY is ignored.

TCL_NAMESPACE_ONLY
  もし旗印内にこのビットが設定されていると変数は現在の名前空間内のみから調べられる; もし手続函数が活性なら､その変数は無視され､大域名前空間はそれが現在の名前空間でない限りやはり無視される｡ If this bit is set in flags then the variable is looked up only in the current namespace; if a procedure is active its variables are ignored, and the global namespace is also ignored unless it is the current namespace.

TCL_LEAVE_ERR_MSG
  もし不都合が返され､且つ､このビットが旗印内に設定されていると､不都合伝言文が解釈実行機能の結果内に残される､それは Tcl_GetObjResult や Tcl_GetStringResult で取戻せる｡もし旗印ビットが設定されない場合､不都合伝言文は残されず､解釈実行機能の結果は修正されない｡ 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.

TCL_APPEND_VALUE
  このビットが設定されていると､ newValuePtr か newValue が現在の値に置換ではなく追記される｡もし変数が現在未定義であると､このビットは無視される｡このビットは Tcl_Set* 手続函数のみで使われる｡ If this bit is set then newValuePtr or newValue is appended to the current value instead of replacing it. If the variable is currently undefined, then the bit is ignored. This bit is only used by the Tcl_Set* procedures.

TCL_LIST_ELEMENT
  このビットが設定されていると､ newValue は変数を設定する(又は追記する)前に適切な Tcl リスト要素に変換される｡リスト要素がリスト或は副リスト(即ち､変数の現在の値が空であるか､一つの文字 “{” ､か “ }” で終わる)の最初の要素ならない限り､区切りの空白が新しいリスト要素の前に追記される｡追記する場合､変数の元の値は適正なリストでなければならず､そこで､操作は新しいリスト要素がリストの上に追記される｡ If this bit is set, then newValue is converted to a valid Tcl list element before setting (or appending to) the variable. A separator space is appended before the new list element unless the list element is going to be the first element in a list or sublist (i.e. the variable's current value is empty, or contains the single character “{”, or ends in “ }”). When appending, the original value of the variable must also be a valid list, so that the operation is the appending of a new list element onto a list.

Tcl_GetVar と Tcl_GetVar2 は変数の現在の値を返す｡これ等の手続函数の引数は Tcl_SetVar and Tcl_SetVar2. への引数と同じ方法で取扱われる｡通常の環境下では､返り値は変数の値へのポインターである(それは Tcl の変数構造内に保存され､ Tcl_SetVar か Tcl_SetVar2 への次の呼出しの前に変化しない)｡Tcl_GetVar と Tcl_GetVar2 は旗印ビットの TCL_GLOBAL_ONLY と TCL_LEAVE_ERR_MSG を使い､両方とも Tcl_SetVar の為には同じ意味を有する｡もし変数の読出しに不都合が生じると(譬えば､変数が実在しない､又は､配列変数が単純変数として指定された)､NULL が返される｡ Tcl_GetVar and Tcl_GetVar2 return the current value of a variable. The arguments to these procedures are treated in the same way as the arguments to Tcl_SetVar and Tcl_SetVar2. Under normal circumstances, the return value is a pointer to the variable's value (which is stored in Tcl's variable structure and will not change before the next call to Tcl_SetVar or Tcl_SetVar2). Tcl_GetVar and Tcl_GetVar2 use the flag bits TCL_GLOBAL_ONLY and TCL_LEAVE_ERR_MSG, both of which have the same meaning as for Tcl_SetVar. If an error occurs in reading the variable (e.g. the variable does not exist or an array element is specified for a scalar variable), then NULL is returned.

Tcl_UnsetVar と Tcl_UnsetVar2 は変数の除去にも遣われ､その後の変数への Tcl_GetVar や Tcl_GetVar2 呼出しは不都合を返す｡これ等の手続函数の引数は Tcl_SetVar と Tcl_SetVar2. への引数と同じ方法で取扱われる｡もし変数が成功裡に除去されると TCL_OK が返される｡もし変数が実在しないとの理由で除去できない場合 TCL_ERROR が返される｡もし配列要素が指定されると､与えられた要素が除去されるが配列は除去されない｡もし配列名が索引なしに指定されると配列全体が除去される｡ Tcl_UnsetVar and Tcl_UnsetVar2 may be used to remove a variable, so that future calls to Tcl_GetVar or Tcl_GetVar2 for the variable will return an error. The arguments to these procedures are treated in the same way as the arguments to Tcl_GetVar and Tcl_GetVar2. If the variable is successfully removed then TCL_OK is returned. If the variable cannot be removed because it does not exist then TCL_ERROR is returned. If an array element is specified, the given element is removed but the array remains. If an array name is specified without an index, then the entire array is removed.

### 参照回数管理 REFERENCE COUNT MANAGEMENT

Tcl_SetVar2Ex と Tcl_ObjSetVar2 と Tcl_GetVar2Ex と Tcl_ObjGetVar2は(もし non-NULLなら)､ 少なくとも1の参照を伴う値であり､ ここで参照は､その函数が操作を行った変数が保持している｡ The result of Tcl_SetVar2Ex, Tcl_ObjSetVar2, Tcl_GetVar2Ex, and Tcl_ObjGetVar2 is (if non-NULL) a value with a reference of at least 1, where that reference is held by the variable that the function has just operated upon.

Tcl_SetVar2Ex と Tcl_ObjSetVar2へのnewValuePtr引数は､任意の参照回数であり得る｡その参照回数は､成功時に増加される｡失敗時には､もし参照回数が零なら､減少され且つ､解放されるので､呼出側は､それには何もする必要はない｡ The newValuePtr argument to Tcl_SetVar2Ex and Tcl_ObjSetVar2 may be an arbitrary reference count value. Its reference count is incremented on success. On failure, if its reference count is zero, it is decremented and freed so the caller need do nothing with it.

Tcl_ObjSetVar2 と Tcl_ObjGetVar2へのpart1Ptr引数は､どの様な参照回数も保持できる｡ これらの函数はそれを修正する事はない｡ The part1Ptr argument to Tcl_ObjSetVar2 and Tcl_ObjGetVar2 can have any reference count. These functions never modify it.

Tcl_ObjSetVar2 と Tcl_ObjGetVar2へのpart2Ptr引数は､もしnon-NULLなら､ 零参照回数を有す筈はない､理由は､これらの函数は､参照をそこに､保持し得るから､ 特に､以前に存在しなかった配列要素の生成に使われた時､及び､ 参照回数の減少で､ 解放されたTcl_Objを指している参照を後に残す時｡[訳註:判らん??] The part2Ptr argument to Tcl_ObjSetVar2 and Tcl_ObjGetVar2, if non-NULL, should not have a zero reference count as these functions may retain a reference to it, particularly when it is used to create an array element that did not previously exist, and decrementing the reference count later would leave them pointing to a freed Tcl_Obj.

### SEE ALSO

Tcl_GetObjResult, Tcl_GetStringResult, Tcl_TraceVar

### KEYWORDS

array, get variable, interpreter, scalar, set, unset, value, variable
Copyright © 1989-1993 The Regents of the University of California.
Copyright © 1994-1997 Sun Microsystems, Inc.