---
name: "GetRelief"
section: "2"
platform: "linux"
package: "perl-tk"
version: "b11.02-5"
release: "Debian 1.3 (Bo)"
platforms: ["linux"]
url: "https://new.carta.tech/GetRelief"
---

# GetRelief(2)

translate between strings and relief values

## NAME

Tk\_GetRelief, Tk\_NameOfRelief - translate between strings and relief values

## SYNOPSIS

```
#include <tk.h>

int
Tk_GetRelief(interp, name, reliefPtr)

char *
Tk_NameOfRelief(relief)
```

## ARGUMENTS

Interpreter to use for error reporting. String containing relief name (one of \`\`flat'', \`\`groove'', \`\`raised'', \`\`ridge'', or \`\`sunken''). Pointer to location in which to store relief value corresponding to *name*. Relief value (one of TK\_RELIEF\_FLAT, TK\_RELIEF\_RAISED, TK\_RELIEF\_SUNKEN, TK\_RELIEF\_GROOVE, or TK\_RELIEF\_RIDGE).

## DESCRIPTION

**Tk\_GetRelief** places in *\*reliefPtr* the relief value corresponding to *name*.  This value will be one of TK\_RELIEF\_FLAT, TK\_RELIEF\_RAISED, TK\_RELIEF\_SUNKEN, TK\_RELIEF\_GROOVE, or TK\_RELIEF\_RIDGE. Under normal circumstances the return value is TCL\_OK and *interp* is unused. If *name* doesn't contain one of the valid relief names or an abbreviation of one of them, then an error message is stored in *interp-\>result*, TCL\_ERROR is returned, and *\*reliefPtr* is unmodified.

**Tk\_NameOfRelief** is the logical inverse of **Tk\_GetRelief**. Given a relief value it returns the corresponding string (\`\`flat'', \`\`raised'', \`\`sunken'', \`\`groove'', or \`\`ridge''). If *relief* isn't a legal relief value, then \`\`unknown relief'' is returned.

## KEYWORDS

name, relief, string