1.2.2.1.1.4.61 BLE_GAP_SetPeriAdvRxEnable

C

uint16_t BLE_GAP_SetPeriAdvRxEnable(uint16_t syncHandle, bool enable);

Description

Enables or disables reports for the periodic advertising train identified by 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.

Events generated

BLE_GAP_EVT_PERI_ADV_REPORT Generated when enabled.

Parameters


Parameter	Description
[in] syncHandle	Identity of the periodic advertising train.
[in] enable	Enable or disable reports. Set true to enable reports.

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully enables or disables reports for 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.