1.2.2.1.1.4.70 BLE_GAP_TerminateSync

C

uint16_t BLE_GAP_TerminateSync(uint16_t syncHandle);

Description

Stop reception of the periodic advertising train identified by the input "syncHandle".

Note

This API belongs to extended advertising feature. It will be disallowed if any one API that belongs to legacy advertising feature is issued before. Categories of advertising APIs and events for details of advertising APIs.

BLE_GAP_ScanInit, BLE_GAP_ExtScanInit and BLE_GAP_SyncInit are required for this API.

Parameters


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

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully stop reception of the periodic advertising train.
MBA_RES_OOM	Internal memory allocation failure.
MBA_RES_COMMAND_DISALLOWED	Command disallowed.
MBA_RES_UNKNOWN_ADV_ID	Unknown advertising identifier.