65 lines
1.7 KiB
Groff
65 lines
1.7 KiB
Groff
.\"
|
|
.\" libdivecomputer
|
|
.\"
|
|
.\" Copyright (C) 2017 Kristaps Dzonsons <kristaps@bsd.lv>
|
|
.\"
|
|
.\" This library is free software; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU Lesser General Public
|
|
.\" License as published by the Free Software Foundation; either
|
|
.\" version 2.1 of the License, or (at your option) any later version.
|
|
.\"
|
|
.\" This library is distributed in the hope that it will be useful,
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
.\" Lesser General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU Lesser General Public
|
|
.\" License along with this library; if not, write to the Free Software
|
|
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
.\" MA 02110-1301 USA
|
|
.\"
|
|
.Dd January 5, 2017
|
|
.Dt DC_BUFFER_GET_DATA 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_buffer_get_data
|
|
.Nd get the data of a buffer
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/buffer.h
|
|
.Ft "unsigned char *"
|
|
.Fo dc_buffer_get_data
|
|
.Fa "dc_buffer_t *buffer"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Get the data used by
|
|
.Fa buffer ,
|
|
previously allocated with
|
|
.Xr dc_buffer_new 3 .
|
|
For the buffer size, use
|
|
.Xr dc_buffer_get_size 3 .
|
|
.Pp
|
|
The returned pointer is not valid after subsequent calls to change the
|
|
buffer.
|
|
.Sh RETURN VALUES
|
|
Returns the data or
|
|
.Dv NULL
|
|
if
|
|
.Fa buffer
|
|
is
|
|
.Dv NULL
|
|
or no data has been allocated to the buffer.
|
|
.Sh SEE ALSO
|
|
.Xr dc_buffer_get_size 3 ,
|
|
.Xr dc_buffer_new 3
|
|
.Sh AUTHORS
|
|
The
|
|
.Lb libdivecomputer
|
|
library was written by
|
|
.An Jef Driesen ,
|
|
.Mt jef@libdivecomputer.org .
|
|
The manpages were written by
|
|
.An Kristaps Dzonsons ,
|
|
.Mt kristaps@bsd.lv .
|