1.2.2.1.1.4.12 BLE_GAP_EnableOneTimeAdv

C

uint16_t BLE_GAP_EnableOneTimeAdv(uint8_t option);

Description

Start one time advertising event.

Note

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_AdvInit is required for this API.

Events generated

BLE_GAP_EVT_ADV_COMPL Generated when one time advertising event is completed. When connection is established, BLE_GAP_EVT_CONNECTED will be generated instead BLE_GAP_EVT_ADV_COMPL event.

Parameters


Parameter	Description
[in] option	Option for one time advertising. See Advertising option.

Return values


Return value	Description
MBA_RES_SUCCESS	Successfully start advertising.
MBA_RES_OOM	Internal memory allocation failure.
MBA_RES_INVALID_PARA	Invalid parameters.
MBA_RES_COMMAND_DISALLOWED	Command disallowed when extended Adv. feature is in-use.