TERMKEY\_GET\_BUFFER\_REMAINING(3) Library Functions Manual TERMKEY\_GET\_BUFFER\_REMAINING(3)

# [NAME](#NAME)

termkey\_get\_buffer\_remaining - returns the free buffer space

# [SYNOPSIS](#SYNOPSIS)

```
#include <termkey.h>

size_t termkey_get_buffer_remaining(TermKey *tk);
```

Link with *-ltermkey*.

# [DESCRIPTION](#DESCRIPTION)

**termkey\_get\_buffer\_remaining**() returns the number of bytes of buffer space currently free in the [**termkey**(7)](/man/os/libtermkey/termkey.7) instance. These bytes are free to use by [**termkey\_push\_bytes**(3)](/man/os/libtermkey/termkey_push_bytes.3), or may be filled by [**termkey\_advisereadable**(3)](/man/os/libtermkey/termkey_advisereadable.3).

# [RETURN VALUE](#RETURN_VALUE)

**termkey\_get\_buffer\_remaining**() returns a size in bytes.

# [SEE ALSO](#SEE_ALSO)

[**termkey\_push\_bytes**(3)](/man/os/libtermkey/termkey_push_bytes.3), [**termkey\_advisereadable**(3)](/man/os/libtermkey/termkey_advisereadable.3), [**termkey\_set\_buffer\_size**(3)](/man/os/libtermkey/termkey_set_buffer_size.3), [**termkey\_get\_buffer\_size**(3)](/man/os/libtermkey/termkey_get_buffer_size.3), [**termkey\_getkey**(3)](/man/os/libtermkey/termkey_getkey.3), [**termkey**(7)](/man/os/libtermkey/termkey.7)

---

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