sd_ble_gap_whitelist_set()

uint32_t sd_ble_gap_whitelist_set	(	ble_gap_addr_t const *const *	pp_wl_addrs,
		uint8_t	len )

#include <ble_gap.h>

Set the active whitelist in the SoftDevice.

Note

Only one whitelist can be used at a time and the whitelist is shared between the BLE roles. The whitelist cannot be set if a BLE role is using the whitelist.

If an address is resolved using the information in the device identity list, then the whitelist filter policy applies to the peer identity address and not the resolvable address sent on air.

Relevant Message Sequence Charts

Whitelist Sharing

Scan Private Devices

Parameters

[in]	pp_wl_addrs	Pointer to a whitelist of peer addresses, if NULL the whitelist will be cleared.
[in]	len	Length of the whitelist, maximum BLE_GAP_WHITELIST_ADDR_MAX_COUNT.

Return values

NRF_SUCCESS	The whitelist is successfully set/cleared.
NRF_ERROR_INVALID_ADDR	The whitelist (or one of its entries) provided is invalid.
BLE_ERROR_GAP_WHITELIST_IN_USE	The whitelist is in use by a BLE role and cannot be set or cleared.
BLE_ERROR_GAP_INVALID_BLE_ADDR	Invalid address type is supplied.
NRF_ERROR_DATA_SIZE	The given whitelist size is invalid (zero or too large); this can only return when pp_wl_addrs is not NULL.