debian man page for lqr_carver_list_start

LQR_CARVER_LIST_START(3)				     LqR library API reference					  LQR_CARVER_LIST_START(3)

NAME
       lqr_carver_list_start - get the staritng point of the attachement list in an LqrCarver object

SYNOPSIS
       #include <lqr.h>

       LqrCarverList* lqr_carver_list_start(LqrCarver* carver);

DESCRIPTION
       The function lqr_carver_list_start returns the stating point of the LqrCarverList object associated with the LqrCarver object pointed to by
       carver, which is used to keep track of the LqrCarver objects attached to it.

       The returned value is NULL if there are no attached carvers.

       Use the functions lqr_carver_list_current(3) and lqr_carver_list_next(3) to access the list element individually, or the function
       lqr_carver_list_foreach(3) to operate on whole lists.

SEE ALSO
       lqr_carver_attach(3), lqr_carver_list_current(3), lqr_carver_list_next(3), lqr_carver_list_foreach(3)

COPYRIGHT
       Copyright (C) 2007-2009 Carlo Baldassi

LqR library 0.4.1 API (3:1:3)					    10 Maj 2009 					  LQR_CARVER_LIST_START(3)