Mercurial > libbuf
annotate buf_dup.3 @ 34:5493466d6e56
misc: update copyright years
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 01 Feb 2023 13:00:51 +0100 |
parents | dbdc17e11648 |
children | ab071d485d38 |
rev | line source |
---|---|
0 | 1 .\" |
2 .\" buf_dup.3 -- simple string buffer for C | |
3 .\" | |
34
5493466d6e56
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
4 .\" Copyright (c) 2019-2023 David Demelier <markand@malikania.fr> |
0 | 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 .\" | |
28
dbdc17e11648
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
22
diff
changeset
|
18 .Dd October 29, 2019-2022 |
0 | 19 .Dt BUF_DUP 3 |
20 .Os | |
21 .\" NAME | |
22 .Sh NAME | |
23 .Nm buf_dup | |
24 .Nd duplicate a string buffer | |
25 .\" SYNOPSIS | |
26 .Sh SYNOPSIS | |
27 .In buf.h | |
21
939fe74cd80a
buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
28 .Ft int |
0 | 29 .Fn buf_dup "struct buf *b" "const struct buf *src" |
30 .\" DESCRIPTION | |
31 .Sh DESCRIPTION | |
32 The pointer | |
33 .Fa b | |
34 must not contain data as it will be overriden and may be let | |
35 unchanged as-is. | |
36 .\" RETURN VALUE | |
37 .Sh RETURN VALUE | |
38 If the | |
39 .Fa src | |
40 buffer isn't initialized (and contains a NULL data field) the destination | |
41 buffer | |
42 .Fa b | |
21
939fe74cd80a
buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
43 is unchanged but the function returns 0. |
0 | 44 .Pp |
45 Otherwise the | |
46 .Fn buf_dup | |
21
939fe74cd80a
buf: switch to int from bool
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
47 function returns -1 in case of error and |
0 | 48 .Va errno |
49 is set to indicate the error. | |
50 .\" ERRORS | |
51 .Sh ERRORS | |
52 .Bl -tag -width Er | |
53 .It Bq Er ENOMEM | |
54 There wasn't enough memory to duplicate the buffer. | |
55 .El | |
56 .\" SEE ALSO | |
57 .Sh SEE ALSO | |
58 .Xr libbuf 3 | |
59 .\" AUTHORS | |
60 .Sh AUTHORS | |
61 The | |
62 .Nm libbuf | |
63 library was written by | |
64 .An David Demelier <markand@malikania.fr> |