next up previous contents index
Next: 16.8.14 amm_iterate_gen: Call a Up: 16.8 API reference Previous: 16.8.12 amm_iterate: Call a

16.8.13 amm_iterate_func: Function to call with every AMM entry (user-provided callout)

 

SYNOPSIS

#include <oskit/amm.h>

int amm_iterate_func(amm_t *amm, amm_entry_t *entry, void *arg);

DESCRIPTION

Function called successively by amm_iterate and amm_iterate_gen with each selected entry from the map amm. The iteration function may modify or destroy the entry passed in.

If this function returns non-zero, the iterator will stop and amm_iterate or amm_iterate_gen will return that non-zero value. Returning zero will continue the iteration.

PARAMETERS

amm
A pointer to the amm_t structure representing the address map.
entry
The selected entry in the map.
arg
The opaque argument provided to amm_iterate and amm_iterate_gen and passed to each instance of amm_iterate_func.

RETURNS

Should return zero if the iteration is to continue, non-zero otherwise.

RELATED INFORMATION

amm_iterate, amm_iterate_gen



University of Utah Flux Research Group