BLE_GAP_CreateSyncCancel

C

uint16_t BLE_GAP_CreateSyncCancel(void);

Description

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

Note

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

Events generated

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

Return values

Return valueDescription
MBA_RES_SUCCESSSuccessfully cancels the synchronization process.
MBA_RES_OOMInternal memory allocation failure occurred.
MBA_RES_COMMAND_DISALLOWEDCommand disallowed due to a conflicting operation or state.