1.1.2.1.1.4.9 BLE_GAP_CreateSyncCancel

C

uint16_t BLE_GAP_CreateSyncCancel(void);

Description

Cancel the BLE_GAP_CreateSync procedure while it is pending.

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.

Events generated

BLE_GAP_EVT_PERI_ADV_SYNC_EST Generated with corresponding status code.

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully cancel the BLE_GAP_CreateSync procedure.
MBA_RES_OOM	Internal memory allocation failure.
MBA_RES_COMMAND_DISALLOWED	Command disallowed.