debian man page for lqr_vmap_list_start

LQR_VMAP_LIST_START(3)					     LqR library API reference					    LQR_VMAP_LIST_START(3)

NAME
       lqr_vmap_list_start - get the LqrVMapList list attached to an LqrCarver

SYNOPSIS
       #include <lqr.h>

       LqrVMapList* lqr_vmap_list_start(LqrCarver* carver);

DESCRIPTION
       The function lqr_vmap_list_start returns the stating point of the LqrVMapList object associated with the LqrCarver object pointed to by
       carver, which is used to keep track of the LqrVMap objects internally dumped by it.

       The returned value is NULL if there are no dumped visibility maps.

       The function lqr_vmap_list_current returns the LqrVMap object corresponding to the current value of the list parameter, or NULL in case of
       errors.

       Use the functions lqr_vmap_list_current(3) and lqr_vmap_list_next(3) to access the list element individually, or the function
       lqr_vmap_list_foreach(3) to operate on whole lists.

SEE ALSO
       lqr_vmap_list_current(3), lqr_vmap_list_next(3), lqr_vmap_list_foreach(3), lqr_vmap_internal_dump(3), lqr_carver_set_dump_vmaps(3)

COPYRIGHT
       Copyright (C) 2007-2009 Carlo Baldassi

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