Welcome to little lamb

Code » limb » master » tree

[master] / src / doc / buffer.h / buffer_unput.3.md 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
% limb manual
% buffer_unput(3)
% limb 0.1.0
% 2023-07-24

# NAME

buffer_unput - "unput" data from a writing I/O buffer

# SYNOPSIS

    #include <limb/buffer.h>

```pre hl
size_t buffer_unput(buffer *<em>buf</em>, size_t <em>len</em>)
```

# DESCRIPTION

The `buffer_unput`() macro will remove up to `len` bytes of data from the buffer
pointed by `buf`. Obviously any data previously written out (via e.g. a call
to [buffer_flush](3)) cannot be removed, only data currently held in the
buffer's internal memory can thusly be removed.

# RETURN VALUE

The `buffer_unput`() function returns the amount of bytes removed from the
buffer, which may be less than `len` (even 0 if the buffer was empty).

# SEE ALSO

[buffer_wseek](3)