BLE_GAP_TerminateSync

C

uint16_t BLE_GAP_TerminateSync(uint16_t syncHandle);

Stops reception of the periodic advertising train identified by the provided syncHandle.

This API is part of the extended advertising feature set and is not compatible with legacy advertising APIs. See Categories of advertising APIs and events for details. Initialization with BLE_GAP_ScanInit, BLE_GAP_ExtScanInit and BLE_GAP_SyncInit is required before using this API.


Parameter	Description
[in] syncHandle	Identity of the periodic advertising train. Range: 0x0000 to 0x0EFF.


Return value	Description
MBA_RES_SUCCESS	Successfully stops reception of the periodic advertising train.
MBA_RES_OOM	Internal memory allocation failure occurred.
MBA_RES_COMMAND_DISALLOWED	Command disallowed due to a conflicting operation or state.
MBA_RES_UNKNOWN_ADV_ID	Unknown advertising identifier.