.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright © 2002 - Philip Howard - All rights reserved
.\"
.\" This program 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
.\"
.TH vrb_data_ptr 3 2002-09-30 vrb "VRB Programmer's Manual"
.SH NAME
vrb_data_ptr - return pointer to data
.SH LIBRARY
.B -lvrb
.SH SYNOPSIS
.B #include <vrb.h>
.sp
.IB "size_t " "vrb_data_ptr" "(vrb_p " "vrb" ");"
.SH DESCRIPTION
.B vrb_data_ptr
returns the pointer to the beginning of the contiguous block of
data within the virtual ring buffer.
The pointer has meaning only if there is data in the buffer.
If there is no data in the buffer, an arbitrary pointer is
returned and must not be used.
Use
.B vrb_data_len(3)
or
.B vrb_is_empty(3)
to determine if
.B vrb_data_ptr(3)
has a meaningful pointer.
.sp
The caller may access all of this data, and should call
.B vrb_take(3)
to indicate how much data has been removed
from the buffer.
.SH ARGUMENTS
.IB "vrb_p " vrb
.br
specifies the virtual ring buffer to obtain the data pointer from.
If a NULL or invalid pointer is given, results are unpredictable
and are likely to be disasterous.
.SH "RETURN VALUE"
.I size_t
.br
The pointer to the data in the virtual ring buffer is returned.
.SH "SEE ALSO"
.BR vrb (3),
.BR vrb_capacity (3),
.BR vrb_data_len (3),
.BR vrb_destroy (3),
.BR vrb_get (3),
.BR vrb_get_min (3),
.BR vrb_give (3),
.BR vrb_init (3),
.BR vrb_init_opt (3),
.BR vrb_is_empty (3),
.BR vrb_is_full (3),
.BR vrb_is_not_empty (3),
.BR vrb_is_not_full (3),
.BR vrb_move (3),
.BR vrb_new (3),
.BR vrb_new_opt (3),
.BR vrb_put (3),
.BR vrb_put_all (3),
.BR vrb_read (3),
.BR vrb_read_min (3),
.BR vrb_resize (3),
.BR vrb_space_len (3),
.BR vrb_space_ptr (3),
.BR vrb_take (3),
.BR vrb_uninit (3),
.BR vrb_write (3),
.BR vrb_write_min (3)