BLE_GAP_RemoveExtAdvSet

C

uint16_t BLE_GAP_RemoveExtAdvSet(uint8_t advHandle);

Description

Removes an advertising set.

Note

This API is part of the extended advertising feature and is incompatible with legacy advertising APIs. See BLE_GAP_ADV_CATS for details on advertising APIs. Initialization with BLE_GAP_AdvInit and BLE_GAP_ExtAdvInit is required before calling this API.

Parameters

ParameterDescription
[in] advHandleThe advertising handle identifying the advertising set to be removed.

Return values

Return valueDescription
MBA_RES_SUCCESSSuccessfully removes an advertising set.
MBA_RES_OOMInternal memory allocation failure occurred.
MBA_RES_INVALID_PARAThe parameters provided are invalid.
MBA_RES_COMMAND_DISALLOWEDCommand disallowed due to a conflicting operation or state.
MBA_RES_UNKNOWN_ADV_IDUnknown advertising identifier.