view buf_dup.3 @ 8:167277f57ce6 0.1.0

misc: update before 0.1.0
author David Demelier <markand@malikania.fr>
date Fri, 30 Oct 2020 13:03:55 +0100
parents b1991ee4451d
children 939fe74cd80a
line wrap: on
line source

.\"
.\" buf_dup.3 -- simple string buffer for C
.\"
.\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr>
.\"
.\" Permission to use, copy, modify, and/or distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd October 29, 2019-2020
.Dt BUF_DUP 3
.Os
.\" NAME
.Sh NAME
.Nm buf_dup
.Nd duplicate a string buffer
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft bool
.Fn buf_dup "struct buf *b" "const struct buf *src"
.\" DESCRIPTION
.Sh DESCRIPTION
The pointer
.Fa b
must not contain data as it will be overriden and may be let
unchanged as-is.
.\" RETURN VALUE
.Sh RETURN VALUE
If the
.Fa src
buffer isn't initialized (and contains a NULL data field) the destination
buffer
.Fa b
is unchanged but the function returns true.
.Pp
Otherwise the
.Fn buf_dup
function returns false in case of error and
.Va errno
is set to indicate the error.
.\" ERRORS
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENOMEM
There wasn't enough memory to duplicate the buffer.
.El
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>