BLE_GAP_TerminateSync

C

uint16_t BLE_GAP_TerminateSync(uint16_t syncHandle);

Description

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

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.

Parameters

ParameterDescription
[in] syncHandleIdentity of the periodic advertising train. Range: 0x0000 to 0x0EFF.

Return values

Return valueDescription
MBA_RES_SUCCESSSuccessfully stops reception of the periodic advertising train.
MBA_RES_OOMInternal memory allocation failure occurred.
MBA_RES_COMMAND_DISALLOWEDCommand disallowed due to a conflicting operation or state.
MBA_RES_UNKNOWN_ADV_IDUnknown advertising identifier.