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

### 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_NewStringObj, Tcl_NewUnicodeObj, Tcl_SetStringObj, Tcl_SetUnicodeObj, Tcl_GetStringFromObj, Tcl_GetString, Tcl_GetUnicodeFromObj, Tcl_GetUnicode, Tcl_GetUniChar, Tcl_GetCharLength, Tcl_GetRange, Tcl_AppendToObj, Tcl_AppendUnicodeToObj, Tcl_AppendObjToObj, Tcl_AppendStringsToObj, Tcl_AppendStringsToObjVA, Tcl_AppendLimitedToObj, Tcl_Format, Tcl_AppendFormatToObj, Tcl_ObjPrintf, Tcl_AppendPrintfToObj, Tcl_SetObjLength, Tcl_AttemptSetObjLength, Tcl_ConcatObj — Tcl 値を文字列として扱う　 manipulate Tcl values as strings
  SYNOPSIS
    #include <tcl.h>
    Tcl_Obj *
    Tcl_NewStringObj(bytes, length)
    Tcl_Obj *
    Tcl_NewUnicodeObj(unicode, numChars)
    void
    Tcl_SetStringObj(objPtr, bytes, length)
    void
    Tcl_SetUnicodeObj(objPtr, unicode, numChars)
    char *
    Tcl_GetStringFromObj(objPtr, lengthPtr)
    char *
    Tcl_GetString(objPtr)
    Tcl_UniChar *
    Tcl_GetUnicodeFromObj(objPtr, lengthPtr)
    Tcl_UniChar *
    Tcl_GetUnicode(objPtr)
    Tcl_UniChar
    Tcl_GetUniChar(objPtr, index)
    int
    Tcl_GetCharLength(objPtr)
    Tcl_Obj *
    Tcl_GetRange(objPtr, first, last)
    void
    Tcl_AppendToObj(objPtr, bytes, length)
    void
    Tcl_AppendUnicodeToObj(objPtr, unicode, numChars)
    void
    Tcl_AppendObjToObj(objPtr, appendObjPtr)
    void
    Tcl_AppendStringsToObj(objPtr, string, string, ... (char *) NULL)
    void
    Tcl_AppendStringsToObjVA(objPtr, argList)
    void
    Tcl_AppendLimitedToObj(objPtr, bytes, length, limit, ellipsis)
    Tcl_Obj *
    Tcl_Format(interp, format, objc, objv)
    int
    Tcl_AppendFormatToObj(interp, objPtr, format, objc, objv)
    Tcl_Obj *
    Tcl_ObjPrintf(format, ...)
    void
    Tcl_AppendPrintfToObj(objPtr, format, ...)
    void
    Tcl_SetObjLength(objPtr, newLength)
    int
    Tcl_AttemptSetObjLength(objPtr, newLength)
    Tcl_Obj *
    Tcl_ConcatObj(objc, objv)
  引数 ARGUMENTS
    const char *bytes (入力in)
    int length (入力in)
    const Tcl_UniChar *unicode (入力in)
    int numChars (入力in)
    int index (入力in)
    int first (入力in)
    int last (入力in)
    Tcl_Obj *objPtr (入出力in/out)
    Tcl_Obj *appendObjPtr (入力in)
    int *lengthPtr (出力out)
    const char *string (入力in)
    va_list argList (入力in)
    int limit (入力in)
    const char *ellipsis (入力in)
    const char *format (入力in)
    int objc (入力in)
    Tcl_Obj *objv[] (入力in)
    int newLength (入力in)
  説明 DESCRIPTION
  SEE ALSO
  KEYWORDS

### NAME

Tcl_NewStringObj, Tcl_NewUnicodeObj, Tcl_SetStringObj, Tcl_SetUnicodeObj, Tcl_GetStringFromObj, Tcl_GetString, Tcl_GetUnicodeFromObj, Tcl_GetUnicode, Tcl_GetUniChar, Tcl_GetCharLength, Tcl_GetRange, Tcl_AppendToObj, Tcl_AppendUnicodeToObj, Tcl_AppendObjToObj, Tcl_AppendStringsToObj, Tcl_AppendStringsToObjVA, Tcl_AppendLimitedToObj, Tcl_Format, Tcl_AppendFormatToObj, Tcl_ObjPrintf, Tcl_AppendPrintfToObj, Tcl_SetObjLength, Tcl_AttemptSetObjLength, Tcl_ConcatObj — Tcl 値を文字列として扱う　 manipulate Tcl values as strings

### SYNOPSIS

#include <tcl.h>
Tcl_Obj *
Tcl_NewStringObj(bytes, length)
Tcl_Obj *
Tcl_NewUnicodeObj(unicode, numChars)
void
Tcl_SetStringObj(objPtr, bytes, length)
void
Tcl_SetUnicodeObj(objPtr, unicode, numChars)
char *
Tcl_GetStringFromObj(objPtr, lengthPtr)
char *
Tcl_GetString(objPtr)
Tcl_UniChar *
Tcl_GetUnicodeFromObj(objPtr, lengthPtr)
Tcl_UniChar *
Tcl_GetUnicode(objPtr)
Tcl_UniChar
Tcl_GetUniChar(objPtr, index)
int
Tcl_GetCharLength(objPtr)
Tcl_Obj *
Tcl_GetRange(objPtr, first, last)
void
Tcl_AppendToObj(objPtr, bytes, length)
void
Tcl_AppendUnicodeToObj(objPtr, unicode, numChars)
void
Tcl_AppendObjToObj(objPtr, appendObjPtr)
void
Tcl_AppendStringsToObj(objPtr, string, string, ... (char *) NULL)
void
Tcl_AppendStringsToObjVA(objPtr, argList)
void
Tcl_AppendLimitedToObj(objPtr, bytes, length, limit, ellipsis)
Tcl_Obj *
Tcl_Format(interp, format, objc, objv)
int
Tcl_AppendFormatToObj(interp, objPtr, format, objc, objv)
Tcl_Obj *
Tcl_ObjPrintf(format, ...)
void
Tcl_AppendPrintfToObj(objPtr, format, ...)
void
Tcl_SetObjLength(objPtr, newLength)
int
Tcl_AttemptSetObjLength(objPtr, newLength)
Tcl_Obj *
Tcl_ConcatObj(objc, objv)

### 引数 ARGUMENTS

const char *bytes (入力in)
  文字列値に設定又は追記するために使用される UTF-8-符号化バイトの配列の最初のバイトを指す｡ numChars が負数でない限り､このバイト配列は埋込み零バイトを含むかもしれない｡ (零バイトを必要とする応用譜はそれらを二つのバイト列 \300\200 で表現すべきである､変換には Tcl_ExternalToUtf か､文字列が未解釈バイトの集合の場合は､ Tcl_NewByteArrayObj を使うべき｡) Points to the first byte of an array of UTF-8-encoded bytes used to set or append to a string value. This byte array may contain embedded null characters unless numChars is negative. (Applications needing null bytes should represent them as the two-byte sequence \300\200, use Tcl_ExternalToUtf to convert, or Tcl_NewByteArrayObj if the string is a collection of uninterpreted bytes.)

int length (入力in)
  文字列値を初期化､設定､追記する場合､バイトから複写すべきバイトの個数｡もし負数なら､最初の零バイト迄の全てのバイトが使用される｡　 The number of bytes to copy from bytes when initializing, setting, or appending to a string value. If negative, all bytes up to the first null are used.

const Tcl_UniChar *unicode (入力in)
  設定されるか文字列値に追記するかのユニコード文字の配列の最初のバイトを指す｡このバイト配列は､ numChars が負数でない限り埋込まれた零バイトを含むかもしれない｡　 Points to the first byte of an array of Unicode characters used to set or append to a string value. This byte array may contain embedded null characters unless numChars is negative.

int numChars (入力in)
  文字列値を初期化､設定､追記する場合､ユニコードから複写すべきユニコード文字の個数｡もし負数なら､最初の零文字迄の全ての文字が使用される｡　 The number of Unicode characters to copy from unicode when initializing, setting, or appending to a string value. If negative, all characters up to the first null character are used.

int index (入力in)
  返すべきユニコード文字の位置｡　 The index of the Unicode character to return.

int first (入力in)
  新しい値として返されるべきユニコード文字範囲内の最初のユニコード文字の位置｡　 The index of the first Unicode character in the Unicode range to be returned as a new value.

int last (入力in)
  新しい値として返されるべきユニコード文字範囲内の最後のユニコード文字の位置｡　 The index of the last Unicode character in the Unicode range to be returned as a new value.

Tcl_Obj *objPtr (入出力in/out)
  操作すべき値を指す｡　 Points to a value to manipulate.

Tcl_Obj *appendObjPtr (入力in)
  Tcl_AppendObjToObj 内の objPtr に追加すべき値｡　 The value to append to objPtr in Tcl_AppendObjToObj.

int *lengthPtr (出力out)
  非零の場合､Tcl_GetStringFromObj の場所は値の文字列表現の長さを保存することになる｡　 If non-NULL, the location where Tcl_GetStringFromObj will store the length of a value's string representation.

const char *string (入力in)
  objPtr に追記すべき零終端文字列値｡　 Null-terminated string value to append to objPtr.

va_list argList (入力in)
  引数リストであって､va_start を使用して初期化し､ va_end を使用して解消せねばならない｡ An argument list which must have been initialized using va_start, and cleared using va_end.

int limit (入力in)
  追記されるべきバイトの最大個数｡　 Maximum number of bytes to be appended.

const char *ellipsis (入力in)
  文字列切捨てへの限界をもたらす時に追記すべき添え字｡もし NULL が渡された場合は添え字は “...” が使用される｡　 Suffix to append when the limit leads to string truncation. If NULL is passed then the suffix “...” is used.

const char *format (入力in)
  変換指定子の % を含む書式化制御文字｡　 Format control string including % conversion specifiers.

int objc (入力in)
  書式化すべき又は連結すべき要素の個数｡　 The number of elements to format or concatenate.

Tcl_Obj *objv[] (入力in)
  書式化すべき又は連結すべき値の配列｡　 The array of values to format or concatenate.

int newLength (入力in)
  objPtr の文字列値に関する､終端の零文字を含まない､新しい長さ｡　 New length for the string value of objPtr, not including the final null character.

### 説明 DESCRIPTION

この取扱説明書の項目に記述されている手続函数は Tcl 値を文字列値として操作させることを許容する｡それらは文字列操作をより効率的にさせる追加情報を保存する為の値の内部表現を使う｡特にそれは､文字列の為に臨時的な貯蔵空間を割当てることにより､それぞれの追記では複写をしなくてもよくして､連続した追記操作を効果的にする｡又､索引行為と､長さの算出は最適化される､理由はユニコード文字列表現は必要に応じて計算と記憶域確保が必要である｡ Tcl_Append* 関連函数を使う時､解釈実行機能の結果が追記される値である時､重要なことは意図せずに既存のデータに結果の値を追記しないことを確認する為に Tcl_ResetResult を呼ぶことである｡ The procedures described in this manual entry allow Tcl values to be manipulated as string values. They use the internal representation of the value to store additional information to make the string manipulations more efficient. In particular, they make a series of append operations efficient by allocating extra storage space for the string so that it does not have to be copied for each append. Also, indexing and length computations are optimized because the Unicode string representation is calculated and cached as needed. When using the Tcl_Append* family of functions where the interpreter's result is the value being appended to, it is important to call Tcl_ResetResult first to ensure you are not unintentionally appending to existing data in the result value.

Tcl_NewStringObj と Tcl_SetStringObj は新しい値を生成するか､既存の値を bytes と length によって与えられた文字列を複写する為に保有する｡Tcl_NewUnicodeObj と Tcl_SetUnicodeObj は新しい値を生成するか､既存の値を unicode と numChars によって与えられたユニコード文字列を複写する為に保有する｡Tcl_NewStringObj と Tcl_NewUnicodeObj は新しく作成された参照数零の値へのポインターを返す｡全ての４つの手続函数は指定された文字列の複写を保持する為に値を設定する｡ Tcl_SetStringObj と Tcl_SetUnicodeObj は値の古い内部表現と同じように古い文字列表現を解放する｡ Tcl_NewStringObj and Tcl_SetStringObj create a new value or modify an existing value to hold a copy of the string given by bytes and length. Tcl_NewUnicodeObj and Tcl_SetUnicodeObj create a new value or modify an existing value to hold a copy of the Unicode string given by unicode and numChars. Tcl_NewStringObj and Tcl_NewUnicodeObj return a pointer to a newly created value with reference count zero. All four procedures set the value to hold a copy of the specified string. Tcl_SetStringObj and Tcl_SetUnicodeObj free any old string representation as well as any old internal representation of the value.

Tcl_GetStringFromObj と Tcl_GetString は値の文字列表現を返す｡これは返されるバイト･ポインターと､非-NULL.の場合に lengthPtr 内に保存される( Tcl_GetStringFromObj の為の)長さによって与えられる｡もし､対象の UTF 文字列表現が不適切(そのバイト･ポインターが NULL)である場合､値の内部表現から再生成される｡返されるバイト･ポインターにより参照される記憶貯蔵は値管理譜により所有される｡それは書込み可能のポインターとして元に渡されるので､自身の Tcl_ObjType の拡張機能の著者は､彼らの Tcl_ObjType. の Tcl_UpdateStringProc 内で文字列表現を修正することが可能である｡但し制限された目的から､ Tcl_GetStringFromObj or Tcl_GetString に返されるポインターは読出し専用として扱うべきである｡このポインターは (const char *) 変数に代入されることを推奨する｡このポインターが書込みに受付けられるとの制限された状況でさえ､文字列表現のその場でのどの様な修正にも先行する適切な Tcl_IsShared と Tcl_DuplicateObj への呼出しと一緒に Tcl_Obj により要求された遅延書込み信号に考慮を払わねばならない｡手続函数 Tcl_GetString は通常の場合､呼出し側が文字列の長さを必要としない場合に使われる｡ Tcl_GetStringFromObj and Tcl_GetString return a value's string representation. This is given by the returned byte pointer and (for Tcl_GetStringFromObj) length, which is stored in lengthPtr if it is non-NULL. If the value's UTF string representation is invalid (its byte pointer is NULL), the string representation is regenerated from the value's internal representation. The storage referenced by the returned byte pointer is owned by the value manager. It is passed back as a writable pointer so that extension author creating their own Tcl_ObjType will be able to modify the string representation within the Tcl_UpdateStringProc of their Tcl_ObjType. Except for that limited purpose, the pointer returned by Tcl_GetStringFromObj or Tcl_GetString should be treated as read-only. It is recommended that this pointer be assigned to a (const char *) variable. Even in the limited situations where writing to this pointer is acceptable, one should take care to respect the copy-on-write semantics required by Tcl_Obj's, with appropriate calls to Tcl_IsShared and Tcl_DuplicateObj prior to any in-place modification of the string representation. The procedure Tcl_GetString is used in the common case where the caller does not need the length of the string representation.

Tcl_GetUnicodeFromObj と Tcl_GetUnicode はTcl_GetUnicodeFromObj と Tcl_GetUnicode はユニコード文字列としての値の値を返す｡これは返されるバイト･ポインターと､非-NULL.の場合に lengthPtr 内に保存される( Tcl_GetStringFromObj の為の)長さによって与えられる｡返されるバイト･ポインターにより参照される記憶貯蔵は値管理譜により所有され､呼出し側に修正されるべきではない｡手続函数 Tcl_GetUnicode は通常の場合､呼出し側がユニコード文字列の長さを必要としない場合に使われる｡ Tcl_GetUnicodeFromObj and Tcl_GetUnicode return a value's value as a Unicode string. This is given by the returned pointer and (for Tcl_GetUnicodeFromObj) length, which is stored in lengthPtr if it is non-NULL. The storage referenced by the returned byte pointer is owned by the value manager and should not be modified by the caller. The procedure Tcl_GetUnicode is used in the common case where the caller does not need the length of the unicode string representation.

Tcl_GetUniChar は値のユニコード表現内の index 番目の文字を返す｡参照番号は適切な範囲にあると假定される｡ Tcl_GetUniChar returns the index'th character in the value's Unicode representation. The index is assumed to be in the appropriate range.

Tcl_GetRange は値をユニコード表現で表した first と last の間(両端を含む)の文字から構成されて新しく生成された値を返す｡もし値のユニコード表現が不適正の場合､ユニコード表現は値の文字列表現から再生成される｡もし first < 0 の場合､返される文字列は値の先頭から始まる｡もし last < 0 の場合､返される値は値の末尾で終わる｡ Tcl_GetRange returns a newly created value comprised of the characters between first and last (inclusive) in the value's Unicode representation. If the value's Unicode representation is invalid, the Unicode representation is regenerated from the value's string representation. If first < 0, then the returned string starts at the beginning of the value. If last < 0, then the returned string ends at the end of the value.

Tcl_GetCharLength は文字列値内の文字の数(バイトではなく)を返す｡ Tcl_GetCharLength returns the number of characters (as opposed to bytes) in the string value. Tcl_AppendToObj は bytes と length によって与えられるデータを objPtr によって指定される対象の文字列表現に追記する｡もしその対象が不適格な文字列表現を含んでいる場合､ bytes をユニコード形式に変換する試みがなされる｡もし､変換が成功すると bytes の変換された形式が値のユニコード表現に追記される｡さもないと､値のユニコード表現は不適格であり UTF 形式に変換される､次いで値の新しい文字列表現に bytes が追記される｡最終的に多重呼出しを最適化する為に巨大な配分により緩衝域の増大がなされる｡ Tcl_AppendToObj appends the data given by bytes and length to the string representation of the value specified by objPtr. If the value has an invalid string representation, then an attempt is made to convert bytes to the Unicode format. If the conversion is successful, then the converted form of bytes is appended to the value's Unicode representation. Otherwise, the value's Unicode representation is invalidated and converted to the UTF format, and bytes is appended to the value's new string representation. Eventually buffer growth is done by large allocations to optimize multiple calls.

Tcl_AppendUnicodeToObj は unicode and numChars によって与えられたユニコード文字列を objPtr.によって指定される対象に追記する｡もし対象が不正なユニコード表現を有している場合､ unicode は UTF 形式に変換され対象の文字列表現に追記される｡追記は比較的効率的に繰返し追記を処理して最適化される(再割付と対象文字列値の複写の繰返しを避ける為に文字列やユニコード領域を過剰割付する)｡ Tcl_AppendUnicodeToObj appends the Unicode string given by unicode and numChars to the value specified by objPtr. If the value has an invalid Unicode representation, then unicode is converted to the UTF format and appended to the value's string representation. Appends are optimized to handle repeated appends relatively efficiently (it over-allocates the string or Unicode space to avoid repeated reallocations and copies of value's string value).

Tcl_AppendObjToObj は Tcl_AppendToObj に似ているが､ appendObjPtr の文字列やユニコード値(どれであれ存在し､ objPtr に最も的確に追記される)を objPtr に追記する｡ Tcl_AppendObjToObj is similar to Tcl_AppendToObj, but it appends the string or Unicode value (whichever exists and is best suited to be appended to objPtr) of appendObjPtr to objPtr.

Tcl_AppendStringsToObj は Tcl_AppendToObj に似ているが､１以上の値を追記する為に渡し､それぞれの値は零終端文字列でなければならない(即ち､どの値も､内部に零文字を含まない)｡幾つの string 引数も供給できるが､最後の引数はリスト末尾を指し示す (char *)NULL でなければならない｡ Tcl_AppendStringsToObj is similar to Tcl_AppendToObj except that it can be passed more than one value to append and each value must be a null-terminated string (i.e. none of the values may contain internal null characters). Any number of string arguments may be provided, but the last argument must be (char *)NULL to indicate the end of the list.

Tcl_AppendStringsToObjVA は Tcl_AppendStringsToObj とほぼ同じであるが､変動個数の引数を取る代りにリスト引数をとる｡ Tcl_AppendStringsToObjVA is the same as Tcl_AppendStringsToObj except that instead of taking a variable number of arguments it takes an argument list.

Tcl_AppendLimitedToObj は Tcl_AppendToObj と略同じであるが､違いは何バイトが追記されるかの限界を強制される｡これは､追記される文字列が非常に大きいかもしれないが､構成される値は束縛なしに増大することは許容されない時に便利である｡通常の用途は不都合伝言文の構成である､其処では､終わりの結果は読む為に充分短く保つべきである｡ bytes からバイトが objPtr に追記されるが､総計 limit バイトより多くは追記されない｡もし制限が全ては阻む場合､ length バイトは追記される為に利用し得るもので､追記がなされ最後のバイトは文字列 ellipsis から追記される｡これは表示の為に文字列内に残され切詰められることを許容する｡ length が -1 の時､最初の例迄の全てのバイトが追記される｡ ellipsis が NULL の時､無為設定の ... が使われる｡ ellipsis が非零の時､ Tcl's 内部表現 UTF 符号の零バイト終端の文字列を指さねばならない｡追記されるバイトの数は length と limit より少なくてもよく､少ないバイトの追記は全バイト文字の追記が必要である｡ Tcl_AppendLimitedToObj is similar to Tcl_AppendToObj except that it imposes a limit on how many bytes are appended. This can be handy when the string to be appended might be very large, but the value being constructed should not be allowed to grow without bound. A common usage is when constructing an error message, where the end result should be kept short enough to be read. Bytes from bytes are appended to objPtr, but no more than limit bytes total are to be appended. If the limit prevents all length bytes that are available from being appended, then the appending is done so that the last bytes appended are from the string ellipsis. This allows for an indication of the truncation to be left in the string. When length is -1, all bytes up to the first zero byte are appended, subject to the limit. When ellipsis is NULL, the default string ... is used. When ellipsis is non-NULL, it must point to a zero-byte-terminated string in Tcl's internal UTF encoding. The number of bytes appended can be less than the lesser of length and limit when appending fewer bytes is necessary to append only whole multi-byte characters.

Tcl_Format は format 命令の機能の C-水準 相互作用である｡ format の為の､実際の命令手続函数は以下より少し多い Tcl_Format is the C-level interface to the engine of the format command. The actual command procedure for format is little more than

    Tcl_Format(interp, Tcl_GetString(objv[1]), objc-2, objv+2);

objc 個の objv 内の Tcl_Obj 値は format 引数内の変換指定に沿って文字列に書式化される｡書式化された結果の文字列は参照数零を伴う新しい Tcl_Obj に変換され､返される｡もし書式化された文字列を生成している間に何かの不都合が生じると､ NULL が返され､もし interp が非-NULL.の場合､不都合伝言文が interp 内に記録される｡ The objc Tcl_Obj values in objv are formatted into a string according to the conversion specification in format argument, following the documentation for the format command. The resulting formatted string is converted to a new Tcl_Obj with refcount of zero and returned. If some error happens during production of the formatted string, NULL is returned, and an error message is recorded in interp, if interp is non-NULL.

Tcl_AppendFormatToObj は以下と等価の機能を持つ Tcl_Format の別形式を追記する: Tcl_AppendFormatToObj is an appending alternative form of Tcl_Format with functionality equivalent to:

    Tcl_Obj *newPtr = Tcl_Format(interp, format, objc, objv);
    if (newPtr == NULL) return TCL_ERROR;
    Tcl_AppendObjToObj(objPtr, newPtr);
    Tcl_DecrRefCount(newPtr);
    return TCL_OK;

しかし､追記の機能が必要な時には､大きな利便性と効率を伴う｡ but with greater convenience and efficiency when the appending functionality is needed.

Tcl_ObjPrintf は次に示す共通の並びの置換に従事する Tcl_ObjPrintf serves as a replacement for the common sequence

    char buf[SOME_SUITABLE_LENGTH];
    sprintf(buf, format, ...);
    Tcl_NewStringObj(buf, -1);

しかし大きな利便性があり､ SOME_SUITABLE_LENGTH を定める必要がない｡書式化は Tcl_Format によって使われるのと同じ核書式化機能譜により行われる｡これは､運営されている変換指定子の組は format 命令のものであるが､その振舞はできる限り sprintf に似ていることを意味する｡ C99 によって追加された書式化( "hh", "ll", "j", "z", "t", "L" の様な)は運営されてない｡ Tcl_ObjPrintf に渡された変換指定が精度を含む時､その値は sprintf の振舞と同じようにバイトの個数として扱われ､ format がなす様な文字の個数としては扱われない｡これは､ C 命令譜では､この様なバイトが表すかもしれない符号化された文字の個数よりも何個のバイトが渡されたたかを知ることの方が多いとの仮定に基く｡渡される引数の数の変数は sprintf に渡す為に適した型であるべきである｡註意すべきは､この例の用途では x は int 型である｡ but with greater convenience and no need to determine SOME_SUITABLE_LENGTH. The formatting is done with the same core formatting engine used by Tcl_Format. This means the set of supported conversion specifiers is that of the format command but the behavior is as similar as possible to sprintf. Format specifiers which were added by C99 (like "hh", "ll", "j", "z", "t", "L") are not supported. When a conversion specifier passed to Tcl_ObjPrintf includes a precision, the value is taken as a number of bytes, as sprintf does, and not as a number of characters, as format does. This is done on the assumption that C code is more likely to know how many bytes it is passing around than the number of encoded characters those bytes happen to represent. The variable number of arguments passed in should be of the types that would be suitable for passing to sprintf. Note in this example usage, x is of type int.

    int x = 5;
    Tcl_Obj *objPtr = Tcl_ObjPrintf("Value is %d", x);

もし format の値が内部不整合か不正な指定子書式を含む場合､ Tcl_ObjPrintf による書式化文字列は不都合を記述する不都合伝言文になる｡しかし､書式とどれかの引続く引数との間の不一致に対する実行時保護を提供することは不可能である｡言語翻訳時の保護はある翻訳譜によって提供されるかもしれない｡ If the value of format contains internal inconsistencies or invalid specifier formats, the formatted string result produced by Tcl_ObjPrintf will be an error message describing the error. It is impossible however to provide runtime protection against mismatches between the format and any subsequent arguments. Compile-time protection may be provided by some compilers.

Tcl_AppendPrintfToObj は次の並びと等価な機能を持つ Tcl_ObjPrintf の代理的な書式を追記する Tcl_AppendPrintfToObj is an appending alternative form of Tcl_ObjPrintf with functionality equivalent to

    Tcl_Obj *newPtr = Tcl_ObjPrintf(format, ...);
    Tcl_AppendObjToObj(objPtr, newPtr);
    Tcl_DecrRefCount(newPtr);

しかし､追記機能が必要な場合は非常に便利で効率的である｡ but with greater convenience and efficiency when the appending functionality is needed.

Tcl_SetObjLength 手続函数はその objPtr 引数の文字列値の長さを変更する｡もし newLength 引数が対象文字列の為に割付けた区域より大きいと文字列区域は再割付され､古い値は新しい区域に複写される; 古い文字列の長さと､新しい長さの間は任意の値を有しうる｡もし newLength が現在の値の文字列の長さより少ないと､文字列空間の再割付なしに objPtr->length が減ぜられる; 元の文字列に割付けられた寸法は値内に記録されるので引続く Tcl_SetObjLength 呼出しで記憶域の再割付なしに文字列が伸ばされ得る｡全ての場合 Tcl_SetObjLength は objPtr->bytes[newLength].の箇所に零文字を残す｡ The Tcl_SetObjLength procedure changes the length of the string value of its objPtr argument. If the newLength argument is greater than the space allocated for the value's string, then the string space is reallocated and the old value is copied to the new space; the bytes between the old length of the string and the new length may have arbitrary values. If the newLength argument is less than the current length of the value's string, with objPtr->length is reduced without reallocating the string space; the original allocated size for the string is recorded in the value, so that the string length can be enlarged in a subsequent call to Tcl_SetObjLength without reallocating storage. In all cases Tcl_SetObjLength leaves a null character at objPtr->bytes[newLength].

Tcl_AttemptSetObjLength は Tcl_SetObjLength と殆ど同一であり､違いは､もし要求を満足する記憶域が満足に割付できない場合､ Tcl 解釈実行機能に panic.を引起さない｡従って､ newLength が対象文字列の為に割付けた区域より大きく､且つ､要求を満足する充分な記憶域がない場合､ Tcl_AttemptSetObjLength は何も活動せず､失敗を指し示す 0 を返す｡もし要求を満足する充分な記憶域がある場合､ Tcl_AttemptSetObjLength は､ Tcl_SetObjLength と丁度同じ振舞いをし成功を意味する 1 を返す｡ Tcl_AttemptSetObjLength is identical in function to Tcl_SetObjLength except that if sufficient memory to satisfy the request cannot be allocated, it does not cause the Tcl interpreter to panic. Thus, if newLength is greater than the space allocated for the value's string, and there is not enough memory available to satisfy the request, Tcl_AttemptSetObjLength will take no action and return 0 to indicate failure. If there is enough memory to satisfy the request, Tcl_AttemptSetObjLength behaves just like Tcl_SetObjLength and returns 1 to indicate success.

Tcl_ConcatObj 函数は､ objv 配列中の全ての対象の文字列を空白区切りで連結した値の新文字列対象を返す｡ Tcl_ConcatObj は objv 配列の再表現文字列の結果への複写として先行と末尾の空白を取除く｡もし､ objv 配列の要素が空白のみで何もない場合､その対象は全部無視される｡従って空白除去は concat 命令の出力に外観の清浄化を追加させる｡ Tcl_ConcatObj はその参照計数零の新しく作成された対象へのポインタを返す｡ The Tcl_ConcatObj function returns a new string value whose value is the space-separated concatenation of the string representations of all of the values in the objv array. Tcl_ConcatObj eliminates leading and trailing white space as it copies the string representations of the objv array to the result. If an element of the objv array consists of nothing but white space, then that value is ignored entirely. This white-space removal was added to make the output of the concat command cleaner-looking. Tcl_ConcatObj returns a pointer to a newly-created value whose ref count is zero.

### SEE ALSO

Tcl_NewObj, Tcl_IncrRefCount, Tcl_DecrRefCount, format, sprintf

### KEYWORDS

append, internal representation, value, value type, string value, string type, string representation, concat, concatenate, unicode
Copyright © 1994-1997 Sun Microsystems, Inc.