.\" Title: \fBlqr_vmap_list_start\fR
.\" Author: Carlo Baldassi
.\" Generator: DocBook XSL Stylesheets v1.73.2
.\" Date: 10 Maj 2009
.\" Manual: LqR library API reference
.\" Source: LqR library 0.4.1 API (3:1:3)
.\"
.TH "\FBLQR_VMAP_LIST_START\FR" "3" "10 Maj 2009" "LqR library 0.4.1 API (3:1:3)" "LqR library API reference"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
lqr_vmap_list_start \- get the LqrVMapList list attached to an LqrCarver
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include
.fi
.ft
.HP 33
.BI "LqrVMapList* lqr_vmap_list_start(LqrCarver*\ " "carver" ");"
.SH "DESCRIPTION"
.PP
The function
\fBlqr_vmap_list_start\fR
returns the stating point of the
LqrVMapList
object associated with the
LqrCarver
object pointed to by
\fIcarver\fR, which is used to keep track of the
LqrVMap
objects internally dumped by it\&.
.PP
The returned value is
NULL
if there are no dumped visibility maps\&.
.PP
The function
\fBlqr_vmap_list_current\fR
returns the
LqrVMap
object corresponding to the current value of the
\fIlist\fR
parameter, or
NULL
in case of errors\&.
.PP
Use the functions
\fBlqr_vmap_list_current\fR(3)
and
\fBlqr_vmap_list_next\fR(3)
to access the list element individually, or the function
\fBlqr_vmap_list_foreach\fR(3)
to operate on whole lists\&.
.SH "SEE ALSO"
.PP
\fBlqr_vmap_list_current\fR(3), \fBlqr_vmap_list_next\fR(3), \fBlqr_vmap_list_foreach\fR(3), \fBlqr_vmap_internal_dump\fR(3), \fBlqr_carver_set_dump_vmaps\fR(3)
.SH "COPYRIGHT"
Copyright \(co 2007-2009 Carlo Baldassi
.br