1.2.2.1.1.4.60 BLE_GAP_SetPeriAdvParams

C

uint16_t BLE_GAP_SetPeriAdvParams(BLE_GAP_PeriAdvParams_T *p_periAdvParams);

Description

Configure periodic advertising parameters.

Note

If the advHandle does not identify an advertising set that is already configured for periodic advertising and it is unable to support more periodic advertising at present.

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_AdvInit, BLE_GAP_ExtAdvInit and BLE_GAP_PeriodicAdvInit are required for this API.

Parameters


Parameter	Description
[in] p_periAdvParams	Pointer to BLE_GAP_PeriAdvParams_T structure buffer.

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully configure periodic advertising parameters.
MBA_RES_OOM	Internal memory allocation failure.
MBA_RES_INVALID_PARA	Invalid parameters.
MBA_RES_COMMAND_DISALLOWED	Command disallowed.
MBA_RES_UNKNOWN_ADV_ID	Unknown advertising identifier.