BLE_GAP_CreateSyncCancel

C

uint16_t BLE_GAP_CreateSyncCancel(void);

Cancels the synchronization process initiated by BLE_GAP_CreateSync while it is pending.

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.

BLE_GAP_EVT_PERI_ADV_SYNC_EST is generated with a corresponding status code when the cancellation is processed.


Return value	Description
MBA_RES_SUCCESS	Successfully cancels the synchronization process.
MBA_RES_OOM	Internal memory allocation failure occurred.
MBA_RES_COMMAND_DISALLOWED	Command disallowed due to a conflicting operation or state.