nrf_802154_bsmap_iterator_begin()

void nrf_802154_bsmap_iterator_begin	(	nrf_802154_bsmap_t *	p_bsmap,
		nrf_802154_bsmap_iterator_t *	p_iter,
		bool	forward )

Start iteration over the BSMAP.

Note

There can be only one iteration started on a given instance pointed by p_bsmap.

To check if iterator is valid (end not reached), call the nrf_802154_bsmap_iterator_is_valid function.

To retrieve data through iterator, call the nrf_802154_bsmap_iterator_rec_key_get and nrf_802154_bsmap_iterator_rec_value_get functions.

To manipulate the BSMAP through the iterator, call the functions nrf_802154_bsmap_iterator_rec_value_write and nrf_802154_bsmap_iterator_rec_delete.

To move the iterator to the next entry, call the nrf_802154_bsmap_iterator_next function.

Iteration over the BSMAP must end with a call to the nrf_802154_bsmap_iterator_finish function.

Parameters

[in]	p_bsmap	Pointer to the BSMAP object to iterate over.
[out]	p_iter	Pointer to an iterator that will be prepared for iteration.
[in]	forward	true to iterate forward. false to iterate backward.