view buf_printf.3 @ 25:fc82452912d0

misc: added signature for changeset dddf94a30fa1
author David Demelier <markand@malikania.fr>
date Thu, 16 Sep 2021 13:59:56 +0200
parents d87e84936795
children dbdc17e11648
line wrap: on
line source

.\"
.\" buf_printf.3 -- simple string buffer for C
.\"
.\" Copyright (c) 2019-2021 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-2021
.Dt BUF_PRINTF 3
.Os
.\" NAME
.Sh NAME
.Nm buf_printf
.Nd write a to a buffer using printf(3) like format
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft int
.Fn buf_printf "struct buf *b" "const char *fmt" "..."
.\" DESCRIPTION
.Sh DESCRIPTION
This function uses the
.Xr printf 3
format to be appended in the buffer
.Fa b .
See the
.Xr printf 3
manual page for a detailed description of
.Fa fmt
string.
.\" RETURN VALUE
.Sh RETURN VALUE
The
.Fn buf_printf
function returns -1 in case of error and
.Va errno
is set to indicate the error.
.\" ERRORS
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENOMEM
Couldn't allocate more memory.
.El
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3 ,
.Xr buf_vprintf 3 ,
.Xr printf 3
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>