view buf_putc.3 @ 20:08a6d4e6012d

misc: added signature for changeset cf6a2b8642c1
author David Demelier <markand@malikania.fr>
date Wed, 16 Dec 2020 16:20:53 +0100
parents b1991ee4451d
children 939fe74cd80a
line wrap: on
line source

.\"
.\" buf_putc.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_PUTC 3
.Os
.\" NAME
.Sh NAME
.Nm buf_putc
.Nd append a single character
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft bool
.Fn buf_putc "struct buf *b" "char c"
.\" DESCRIPTION
.Sh DESCRIPTION
Append the
.Fa c
character into the buffer specified by
.Fa b .
.Pp
This function should be avoided for performance reasons unless you reserve more
storage using
.Fn buf_reserve
prior to calling this function. See
.Xr buf_reserve 3
for more details.
.\" RETURN VALUE
.Sh RETURN VALUE
The
.Fn buf_putc
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
Couldn't allocate more memory.
.El
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3 ,
.Xr buf_reserve 3
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>