Mercurial > libbuf
comparison buf_finish.3 @ 0:b1991ee4451d
misc: initial import
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 29 Oct 2020 17:24:30 +0100 |
parents | |
children | d87e84936795 |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:b1991ee4451d |
---|---|
1 .\" | |
2 .\" buf_finish.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_FINISH 3 | |
20 .Os | |
21 .\" NAME | |
22 .Sh NAME | |
23 .Nm buf_finish | |
24 .Nd clear the buffer and free resources | |
25 .\" SYNOPSIS | |
26 .Sh SYNOPSIS | |
27 .In buf.h | |
28 .Ft void | |
29 .Fn buf_finish "struct buf *b" | |
30 .\" DESCRIPTION | |
31 .Sh DESCRIPTION | |
32 Free the internal resources and reset the buffer state specified by | |
33 .Fa b . | |
34 .Pp | |
35 The buffer may be freely reused after calling the | |
36 .Fn buf_finish | |
37 function, it is also safe to call the function on a finalized buffer as well. | |
38 .\" SEE ALSO | |
39 .Sh SEE ALSO | |
40 .Xr libbuf 3 , | |
41 .Xr buf_clear | |
42 .\" AUTHORS | |
43 .Sh AUTHORS | |
44 The | |
45 .Nm libbuf | |
46 library was written by | |
47 .An David Demelier <markand@malikania.fr> |