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 Categories of advertising APIs and events for details on advertising APIs. Initialization with BLE_GAP_AdvInit and BLE_GAP_ExtAdvInit is required before calling this API.
Parameters
Parameter | Description |
---|---|
[in] advHandle | The advertising handle identifying the advertising set to be removed. |
Return values
Return value | Description |
---|---|
MBA_RES_SUCCESS | Successfully removes an advertising set. |
MBA_RES_OOM | Internal memory allocation failure occurred. |
MBA_RES_INVALID_PARA | The parameters provided are invalid. |
MBA_RES_COMMAND_DISALLOWED | Command disallowed due to a conflicting operation or state. |
MBA_RES_UNKNOWN_ADV_ID | Unknown advertising identifier. |