Tk\_GetCapStyle(3) Tk Library Procedures Tk\_GetCapStyle(3)

```

```

# [NAME](#NAME)

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

# [SYNOPSIS](#SYNOPSIS)

```
#include <tk.h>

int
Tk_GetCapStyle(interp, string, capPtr)

const char *
Tk_NameOfCapStyle(cap)
```

# [ARGUMENTS](#ARGUMENTS)

Tcl\_Interp *\*interp* (in)

Interpreter to use for error reporting.

const char *\*string* (in)

String containing name of cap style - one of “**butt**”, “**projecting**”, or “**round**” - or a unique abbreviation of one.

int *\*capPtr* (out)

Pointer to location in which to store X cap style corresponding to *string*.

int *cap* (in)

Cap style: one of **CapButt**, **CapProjecting**, or **CapRound**.

```
    
```

# [DESCRIPTION](#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* does not contain a valid cap style or an abbreviation of one of these names, then an error message is stored in interpreter *interp*'s 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* is not a legal cap style, then “unknown cap style” is returned.

# [KEYWORDS](#KEYWORDS)

butt, cap style, projecting, round

Tk

---

Document: Tk_NameOfCapStyle(3) from tk 9.0.4-r2 (Chainguard OS)
Source: https://downloads.sourceforge.net/sourceforge/tcl/tk9.0.4-src.tar.gz