Mercurial > libbuf
view buf_sub.3 @ 28:dbdc17e11648
misc: update copyright years
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 02 Jan 2022 10:15:18 +0100 |
parents | d87e84936795 |
children | 5493466d6e56 |
line wrap: on
line source
.\" .\" buf_sub.3 -- simple string buffer for C .\" .\" Copyright (c) 2019-2022 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-2022 .Dt BUF_SUB 3 .Os .\" NAME .Sh NAME .Nm buf_sub .Nd duplicate a specific portion from the buffer .\" SYNOPSIS .Sh SYNOPSIS .In buf.h .Ft int .Fn buf_sub "struct buf *b" "const struct buf *src" "size_t pos" "size_t count" .\" DESCRIPTION .Sh DESCRIPTION Extract the portion at position .Fa pos from the buffer specified by .Fa src with .Fa count number of characters and set to .Fa b . .Pp This function will first initialize and allocate the buffer specified by .Fa b to fill the portion length. It should not contain any data because it will be overwritten. .Pp The .Fa count argument can be set to -1 to extract data until the end of the .Fa src buffer. .Pp Undefined behavior may occur if the .Fa pos argument is outside of the buffer bounds. .\" RETURN VALUE .Sh RETURN VALUE The .Fn buf_sub 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 Memory allocation failed. .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>