## Tcl9.0.3/Tk9.0.3 Documentation > Tk C API > GetRelief

### 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
    Tk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief — 文字列と立体値の間の翻訳　translate between strings and relief values
  SYNOPSIS
    #include <tk.h>
    int
    Tk_GetReliefFromObj(interp, objPtr, reliefPtr)
    int
    Tk_GetRelief(interp, name, reliefPtr)
    const char *
    Tk_NameOfRelief(relief)
  引数 ARGUMENTS
    Tcl_Interp *interp (入力in)
    Tcl_Obj *objPtr (入出力in/out)
    const char *name (入力in)
    int *reliefPtr (出力)
    int relief (入力in)
  説明 DESCRIPTION
  KEYWORDS

### NAME

Tk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief — 文字列と立体値の間の翻訳　translate between strings and relief values

### SYNOPSIS

#include <tk.h>
int
Tk_GetReliefFromObj(interp, objPtr, reliefPtr)
int
Tk_GetRelief(interp, name, reliefPtr)
const char *
Tk_NameOfRelief(relief)

### 引数 ARGUMENTS

Tcl_Interp *interp (入力in)
  不都合の報告に使う為の解釈実行機能｡ Interpreter to use for error reporting.

Tcl_Obj *objPtr (入出力in/out)
  立体感の名前を含む文字列値､ “flat” か “groove” か “raised” か “ridge” か “solid” か “sunken” の内(又は､その入力の明確に識別されえる短縮形)の一つ｡内部代表は対応する立体感の値への高速記憶域への指示子を修正する｡(訳註 flat:平坦 groove:溝 raised:隆起 ridge:畔 solid:筋 sunken:陥没)　　　　　 String value contains name of relief, one of “flat”, “groove”, “raised”, “ridge”, “solid”, or “sunken” (or any unique abbreviation thereof on input); the internal rep will be modified to cache corresponding relief value.

const char *name (入力in)
  objPtr と同一､但し､立体感の記述は文字列として手渡される｡　 Same as objPtr except description of relief is passed as a string.

int *reliefPtr (出力)
  objPtr か名前に相当する立体感値を保存する場所への指示子｡　 Pointer to location in which to store relief value corresponding to objPtr or name.

int relief (入力in)
  立体感の値(TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN, TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGEの内の一つ)｡ Relief value (one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN, TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE).

### 説明 DESCRIPTION

Tk_GetReliefFromObj は *reliefPtr 内に objPtr の値に相当する立体感の値を置く｡この値はTK_RELIEF_FLATか TK_RELIEF_RAISEDか TK_RELIEF_SUNKENか TK_RELIEF_GROOVEか TK_RELIEF_SOLID か TK_RELIEF_RIDGE の内の一つでなければならない｡通常の状況では､返り値は TCL_OK であり interp は使用されない｡もし objPtr が適切な立体感の名前かその短縮名の内の一つを含まない場合､ TCL_ERROR が返され､ *reliefPtr は修正されず､解釈実行機能が NULL でなければ､不都合伝言文が解釈実行機能の結果内に残される｡Tk_GetReliefFromObj は objPtr 内の返り値に関する情報を高速記憶し､同じ objPtr を使う将来の Tk_GetReliefFromObj 呼出しを加速している｡ Tk_GetReliefFromObj places in *reliefPtr the relief value corresponding to the value of objPtr. This value will be one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN, TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE. Under normal circumstances the return value is TCL_OK and interp is unused. If objPtr does not contain one of the valid relief names or an abbreviation of one of them, then TCL_ERROR is returned, *reliefPtr is unmodified, and an error message is stored in interp's result if interp is not NULL. Tk_GetReliefFromObj caches information about the return value in objPtr, which speeds up future calls to Tk_GetReliefFromObj with the same objPtr.

Tk_GetRelief は立体感の記述が対象ではなく文字列によることを除き Tk_GetReliefFromObj と同一である｡これは Tk_GetRelief に返り値の高速記憶を妨げているので､ Tk_GetRelief はTk_GetReliefFromObj より効率は見劣りする｡ Tk_GetRelief is identical to Tk_GetReliefFromObj except that the description of the relief is specified with a string instead of an object. This prevents Tk_GetRelief from caching the return value, so Tk_GetRelief is less efficient than Tk_GetReliefFromObj.

Tk_NameOfRelief は論理的に Tk_GetRelief の逆のものである｡立体感の値が与えられ､相当する文字列を返す(flat か raised か sunken か groove か solid か ridge)｡もし relief が適正な立体感の値でない場合､ “unknown relief(未知の立体感)” が返される｡ Tk_NameOfRelief is the logical inverse of Tk_GetRelief. Given a relief value it returns the corresponding string (flat, raised, sunken, groove, solid, or ridge). If relief is not a legal relief value, then “unknown relief” is returned.

### KEYWORDS

name, relief, string
Copyright © 1990 The Regents of the University of California.
Copyright © 1994-1998 Sun Microsystems, Inc.