BLE_GAP_SetScanningParam
C
uint16_t BLE_GAP_SetScanningParam(BLE_GAP_ScanningParams_T *p_scanParams);Description
Sets the scanning parameters.
Note
This API should not be called while scanning is active. It is part of the legacy advertising feature set and will be disallowed if any API from the extended advertising feature set has been used previously. See Categories of advertising APIs and events for details on advertising APIs. The BLE_GAP_ScanInit function must be called prior to using this API.
Parameters
| Parameter | Description |
|---|---|
| [in] p_scanParams | Pointer to a BLE_GAP_ScanningParams_T structure containing the desired scanning parameters. |
Return values
| Return value | Description |
|---|---|
| MBA_RES_SUCCESS | Successfully sets scanning parameters. |
| MBA_RES_OOM | Internal memory allocation failure occurred. |
| MBA_RES_INVALID_PARA | Invalid parameters, such as out-of-range scanning parameters. |
| MBA_RES_COMMAND_DISALLOWED | Command disallowed when the extended advertising feature is in use. |