1.2.2.1.1.4.66 BLE_GAP_SetScanningParam

C

uint16_t BLE_GAP_SetScanningParam(BLE_GAP_ScanningParams_T *p_scanParams);

Description

Set the Scanning Parameters.

Note

This API should not be called when scanning is enabled.

This API belongs to legacy advertising feature. It will be disallowed if any one API belongs extended advertising feature is issued before. Categories of advertising APIs and events for details of advertising APIs.

BLE_GAP_ScanInit is required for this API.

Parameters


Parameter	Description
[in] p_scanParams	Pointer to BLE_GAP_ScanningParams_T structure buffer.

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully set scanning parameters.
MBA_RES_OOM	Internal memory allocation failure.
MBA_RES_INVALID_PARA	Invalid parameters, if any of the scanning parameters are out of range.
MBA_RES_COMMAND_DISALLOWED	Command disallowed when extended Adv. feature is in-use.