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

# GetCapStyl(2)

translate between strings and cap styles

## NAME

Tk\_GetCapStyle, Tk\_NameOfCapStyle - translate between strings and cap styles

## SYNOPSIS

```
#include <tk.h>

int
Tk_GetCapStyle(interp, string, capPtr)

char *
Tk_NameOfCapStyle(cap)
```

## ARGUMENTS

Interpreter to use for error reporting. String containing name of cap style: one of \`\`\`butt'', \`\`projecting'', or \`\`round''. Pointer to location in which to store X cap style corresponding to *string*. Cap style: one of **CapButt**, **CapProjecting**, or **CapRound**.

## DESCRIPTION

**Tk\_GetCapStyle** places in *\*capPtr* the X cap style corresponding to *string*. This will be one of the values **CapButt**, **CapProjecting**, or **CapRound**. Cap styles are typically used in X graphics contexts to indicate how the end-points of lines should be capped. See the X documentation for information on what each style implies.

Under normal circumstances the return value is **TCL\_OK** and *interp* is unused. If *string* doesn't contain a valid cap style or an abbreviation of one of these names, then an error message is stored in *interp-\>result*, **TCL\_ERROR** is returned, and *\*capPtr* is unmodified.

**Tk\_NameOfCapStyle** is the logical inverse of **Tk\_GetCapStyle**. Given a cap style such as **CapButt** it returns a statically-allocated string corresponding to *cap*. If *cap* isn't a legal cap style, then \`\`unknown cap style'' is returned.

## KEYWORDS

butt, cap style, projecting, round