BLE_GAP_SetDataRelatedAddrChange

C

uint16_t BLE_GAP_SetDataRelatedAddrChange(uint8_t advHandle, uint8_t changeReasons);

Description

Sets data related address changes.

Note

This function refreshes the Resolvable Private Address used by the advertising set identified by the advHandle parameter, whether or not the address timeout period has been reached. The changeReasons parameter specifies the reason(s) for refreshing addresses. If any legacy advertising feature API has been used previously, the advHandle parameter is ignored.

Parameters

ParameterDescription
[in] advHandleIdentifies the advertising set.
[in] changeReasonsIndicates when to change the address, see Reasons for changing the address.

Return values

Return valueDescription
MBA_RES_SUCCESSSuccessfully sets data related address changes.
MBA_RES_INVALID_PARAThe parameters provided are invalid.
MBA_RES_UNKNOWN_ADV_IDUnknown advertising identifier.