0
|
1 .\" |
|
2 .\" buf_erase.3 -- simple string buffer for C |
|
3 .\" |
|
4 .\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr> |
|
5 .\" |
|
6 .\" Permission to use, copy, modify, and/or distribute this software for any |
|
7 .\" purpose with or without fee is hereby granted, provided that the above |
|
8 .\" copyright notice and this permission notice appear in all copies. |
|
9 .\" |
|
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
17 .\" |
|
18 .Dd October 29, 2019-2020 |
|
19 .Dt BUF_ERASE 3 |
|
20 .Os |
|
21 .\" NAME |
|
22 .Sh NAME |
|
23 .Nm buf_erase |
|
24 .Nd erase a portion of the string |
|
25 .\" SYNOPSIS |
|
26 .Sh SYNOPSIS |
|
27 .In buf.h |
|
28 .Ft void |
|
29 .Fn buf_erase "struct buf *b" "size_t pos" "size_t count" |
|
30 .\" DESCRIPTION |
|
31 .Sh DESCRIPTION |
|
32 Remove |
|
33 .Fa count |
|
34 number of character in the buffer specified by |
|
35 .Fa b |
|
36 starting at |
|
37 .Fa pos . |
|
38 .Pp |
|
39 It is possible to pass -1 as |
|
40 .Fa count |
|
41 parameter to remove the remaining text until the end of the string. |
|
42 .Pp |
|
43 Undefined behavior may occur if the |
|
44 .Fa pos |
|
45 argument is outside of the buffer bounds. |
|
46 .\" SEE ALSO |
|
47 .Sh SEE ALSO |
|
48 .Xr libbuf 3 |
|
49 .\" AUTHORS |
|
50 .Sh AUTHORS |
|
51 The |
|
52 .Nm libbuf |
|
53 library was written by |
|
54 .An David Demelier <markand@malikania.fr> |