nrfxlib API 3.3.99
Loading...
Searching...
No Matches

◆ nrf_802154_bsmap_rec_delete()

bool nrf_802154_bsmap_rec_delete ( nrf_802154_bsmap_t * p_bsmap,
const void * p_key,
void * p_aux_memory )

Delete a record associated with a key from the BSMAP.

This function is optimized for low priority execution. It is thread-safe with respect to high priority lookups performed by the nrf_802154_bsmap_rec_get function.

This function is not thread-safe with respect to itself or nrf_802154_bsmap_rec_write.

Parameters
[in]p_bsmapPointer to the BSMAP object to write to.
[in]p_keyPointer to the key to write. Must not be NULL.
[in]p_aux_memoryPointer to an auxiliary memory storage used during modification. It must be able to store NRF_802154_BSMAP_AUX_MEMORY_SIZE bytes.
Return values
trueIf the record was found and deleted from the BSMAP.
falseIf the record was not found in the BSMAP. This result means also that the goal of the function (not having the key in the BSMAP) is achieved. This does not necessarily mean that there is an error.