debian man page for vrb_get

vrb_get(3)						      VRB Programmer's Manual							vrb_get(3)

NAME
       vrb_get - get data from a VRB

LIBRARY
       -lvrb

SYNOPSIS
       #include <vrb.h>

       size_t vrb_get(vrb_p vrb, char *target, size_t size);

DESCRIPTION
       vrb_get Get data from a virtual ring buffer and copy it to the space provider by the caller.  If less data is available in the virtual ring
       buffer, then only as much will be copied as is available.

ARGUMENTS
       vrb_p vrb
       specifies which virtual ring buffer.

       char *target
       specifies the location where to copy the data to.

       size_t size
       specifies the maximum length of data to obtain from the virtual ring buffer.

RETURN VALUE
       size_t
       The actual length of data copied is returned, which can be any value from 0 to the specified size.

ERRORS
       If an error is returned, then errno will have the following value:

       EINVAL An invalid virtual ring buffer pointer was specified.

SEE ALSO
       vrb(3), vrb_capacity(3), vrb_data_len(3),  vrb_data_ptr(3),  vrb_destroy(3),  vrb_get_min(3),  vrb_give(3),  vrb_init(3),  vrb_init_opt(3),
       vrb_is_empty(3),   vrb_is_full(3),   vrb_is_not_empty(3),   vrb_is_not_full(3),	 vrb_move(3),	vrb_new(3),   vrb_new_opt(3),  vrb_put(3),
       vrb_put_all(3), vrb_read(3), vrb_read_min(3), vrb_resize(3), vrb_space_len(3), vrb_space_ptr(3), vrb_take(3), vrb_uninit(3),  vrb_write(3),
       vrb_write_min(3)

vrb								    2002-09-30								vrb_get(3)