TERMKEY\_INTERPRET\_POSITION(3) Library Functions Manual TERMKEY\_INTERPRET\_POSITION(3)

# [NAME](#NAME)

termkey\_interpret\_position - interpret opaque cursor position event data

# [SYNOPSIS](#SYNOPSIS)

```
#include <termkey.h>

TermKeyResult termkey_interpret_position(TermKey *tk, const TermKeyKey *key, 
    int *line, int *col);
```

Link with *-ltermkey*.

# [DESCRIPTION](#DESCRIPTION)

**termkey\_interpret\_position**() fills in variables in the passed pointers according to the cursor position report event found in *key*. It should be called if [**termkey\_getkey**(3)](/man/os/libtermkey/termkey_getkey.3) or similar have returned a key event with the type of **TERMKEY\_TYPE\_POSITION**.

Any pointer may instead be given as **NULL** to not return that value.

The *line* and *col* variables will be filled in with the cursor position, indexed from 1. Note that due to the limited number of bytes in the **TermKeyKey** structure, the line and column numbers are limited to 2047 and 4095 respectively.

# [RETURN VALUE](#RETURN_VALUE)

If passed a *key* event of the type **TERMKEY\_TYPE\_POSITION**, this function will return **TERMKEY\_RES\_KEY** and will affect the variables whose pointers were passed in, as described above.

For other event types it will return **TERMKEY\_RES\_NONE**, and its effects on any variables whose pointers were passed in, are undefined.

# [SEE ALSO](#SEE_ALSO)

[**termkey\_waitkey**(3)](/man/os/libtermkey/termkey_waitkey.3), [**termkey\_getkey**(3)](/man/os/libtermkey/termkey_getkey.3), [**termkey**(7)](/man/os/libtermkey/termkey.7)

---

Document: termkey_interpret_position(3) from libtermkey 0.22-r8 (Chainguard OS)