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

### 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_GetAssocData, Tcl_SetAssocData, Tcl_DeleteAssocData — 文字列鍵と使用者固有データに対する Tcl 解釈実行機能の結合を管理する manage associations of string keys and user specified data with Tcl interpreters
  SYNOPSIS
    #include <tcl.h>
    ClientData
    Tcl_GetAssocData(interp, key, delProcPtr)
    Tcl_SetAssocData(interp, key, delProc, clientData)
    Tcl_DeleteAssocData(interp, key)
  引数 ARGUMENTS
    Tcl_Interp *interp (入力in)
    const char *key (入力in)
    Tcl_InterpDeleteProc *delProc (入力in)
    Tcl_InterpDeleteProc **delProcPtr (入力in)
    ClientData clientData (入力in)
  説明 DESCRIPTION
  KEYWORDS

### NAME

Tcl_GetAssocData, Tcl_SetAssocData, Tcl_DeleteAssocData — 文字列鍵と使用者固有データに対する Tcl 解釈実行機能の結合を管理する manage associations of string keys and user specified data with Tcl interpreters

### SYNOPSIS

#include <tcl.h>
ClientData
Tcl_GetAssocData(interp, key, delProcPtr)
Tcl_SetAssocData(interp, key, delProc, clientData)
Tcl_DeleteAssocData(interp, key)

### 引数 ARGUMENTS

Tcl_Interp *interp (入力in)
  指定された命令を実行する為の解釈実行機能｡ Interpreter in which to execute the specified command.

const char *key (入力in)
  データを一緒に保存したり､データをそこから削除したり､取出したりする結合の為の鍵｡典型的には梱包の為の前置的機能｡ Key for association with which to store data or from which to delete or retrieve data. Typically the module prefix for a package.

Tcl_InterpDeleteProc *delProc (入力in)
  interp が消去される時に呼ぶ手続函数｡ Procedure to call when interp is deleted.

Tcl_InterpDeleteProc **delProcPtr (入力in)
  結合の為の現在の消去手続函数の番地を保存する場所へのポインタ｡零文字NULLの場合は無視される｡ Pointer to location in which to store address of current deletion procedure for association. Ignored if NULL.

ClientData clientData (入力in)
  この解釈実行機能内の与えられた鍵に結合した任意の１語の値｡このデータは呼出し側が所有する Arbitrary one-word value associated with the given key in this interpreter. This data is owned by the caller.

### 説明 DESCRIPTION

この手続函数は自身のデータを Tcl 解釈実行機能と結合する為の機能拡張を許容する｡結合は､文字列鍵と､典型的には機能拡張の名前と､１語の値であって典型的には固有の拡張へのデータを保有するデータ構造へのポインタ､から構成される｡Tcl は結合のための鍵にも値にも解釈を行わない｡ These procedures allow extensions to associate their own data with a Tcl interpreter. An association consists of a string key, typically the name of the extension, and a one-word value, which is typically a pointer to a data structure holding data specific to the extension. Tcl makes no interpretation of either the key or the value for an association.

記憶域の管理は解釈実行機能が削除された時に呼出すべき手続函数のそれぞれの結合と共に保存することにより促進される｡この手続函数はそれが叶った方法で要求元により占有された記憶域を配置することができる｡ Storage management is facilitated by storing with each association a procedure to call when the interpreter is deleted. This procedure can dispose of the storage occupied by the client's data in any way it sees fit.

Tcl_SetAssocData は文字列鍵と与えられた解釈実行機能内の使用者に指定されたデータとの結合を生成する｡もし与えられた key が既に結合が実在する場合､Tcl_SetAssocData は新しい情報によってそれに上書きする｡譬えば､鍵名として梱包名を使うなどして､名前の使用を組織だてして矛盾を避けることは使用者の責任である｡もし､deleteProc 引数が非-NULL である場合､それは､結合が削除される前に解釈実行機能が削除される時に起動される手続函数の番地を指定している｡DeleteProc は Tcl_InterpDeleteProc の型と一致する引数と結果を有するべきである: Tcl_SetAssocData creates an association between a string key and a user specified datum in the given interpreter. If there is already an association with the given key, Tcl_SetAssocData overwrites it with the new information. It is up to callers to organize their use of names to avoid conflicts, for example, by using package names as the keys. If the deleteProc argument is non-NULL it specifies the address of a procedure to invoke if the interpreter is deleted before the association is deleted. DeleteProc should have arguments and result that match the type Tcl_InterpDeleteProc:

    typedef void Tcl_InterpDeleteProc(
            ClientData clientData,
            Tcl_Interp *interp);

deleteProc が起動されたとき､clientData と interp 引数は対応する Tcl_SetAssocData に渡された引数と同じである｡削除手続函数は､もし解釈実行機能が削除される前に結合が削除た時には起動されることはない｡ 　　 When deleteProc is invoked the clientData and interp arguments will be the same as the corresponding arguments passed to Tcl_SetAssocData. The deletion procedure will not be invoked if the association is deleted before the interpreter is deleted.

Tcl_GetAssocData は与えられた解釈実行機能内の指定された鍵の結合内に保存された１つのデータを返し､もし delProcPtr 欄が非-NULL で満たされていると､それが指し示す番地がこの結合により保存された削除手続函数の番地を得る｡もし与えられた解釈実行機能内に指定された鍵の結合が実在しない場合は Tcl_GetAssocData は NULL を返す｡ Tcl_GetAssocData returns the datum stored in the association with the specified key in the given interpreter, and if the delProcPtr field is non-NULL, the address indicated by it gets the address of the delete procedure stored with this association. If no association with the specified key exists in the given interpreter Tcl_GetAssocData returns NULL.

Tcl_DeleteAssocData は与えられた解釈実行機能内の指定された鍵の結合を削除する｡次いで､削除手続函数を呼ぶ｡ Tcl_DeleteAssocData deletes an association with a specified key in the given interpreter. Then it calls the deletion procedure.

### KEYWORDS

association, data, deletion procedure, interpreter, key
Copyright © 1995-1996 Sun Microsystems, Inc.