TERMKEY\_GET\_KEYNAME(3) Library Functions Manual TERMKEY\_GET\_KEYNAME(3)

# [NAME](#NAME)

termkey\_get\_keyname - return a string name for a symbolic key

# [SYNOPSIS](#SYNOPSIS)

```
#include <termkey.h>

const char *termkey_get_keyname(TermKey *tk, TermKeySym sym);
```

Link with *-ltermkey*.

# [DESCRIPTION](#DESCRIPTION)

**termkey\_get\_keyname**() returns a human-readable string name for the symbolic key value given by *sym*. The returned string is owned by the [**termkey**(7)](/man/os/libtermkey/termkey.7) instance *tk* so should not be modified or freed. The returned pointer is guaranteed to be valid until the instance is released using [**termkey\_destroy**(3)](/man/os/libtermkey/termkey_destroy.3). This function is the inverse of [**termkey\_keyname2sym**(3)](/man/os/libtermkey/termkey_keyname2sym.3).

# [RETURN VALUE](#RETURN_VALUE)

**termkey\_get\_key**() returns a pointer to a string.

# [SEE ALSO](#SEE_ALSO)

[**termkey\_lookup\_keyname**(3)](/man/os/libtermkey/termkey_lookup_keyname.3), [**termkey\_keyname2sym**(3)](/man/os/libtermkey/termkey_keyname2sym.3), [**termkey\_strfkey**(3)](/man/os/libtermkey/termkey_strfkey.3), [**termkey**(7)](/man/os/libtermkey/termkey.7)

---

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