◆ sdc_hci_cmd_le_periodic_adv_create_sync_cancel()

uint8_t sdc_hci_cmd_le_periodic_adv_create_sync_cancel ( void )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Periodic Advertising Create Sync Cancel.

The description below is extracted from Core_v6.0, Vol 4, Part E, Section 7.8.68

The HCI_LE_Periodic_Advertising_Create_Sync_Cancel command is used to cancel the HCI_LE_Periodic_Advertising_Create_Sync command while it is pending.

If the Host issues this command while no HCI_LE_Periodic_Advertising_Create_Sync command is pending, the Controller shall return the error code Command Disallowed (0x0C).

Event(s) generated (unless masked away): When the HCI_LE_Periodic_Advertising_Create_Sync_Cancel command has completed, the Controller sends an HCI_Command_Complete event to the Host.

After the HCI_Command_Complete is sent and if the cancellation was successful, the Controller sends an HCI_LE_Periodic_Advertising_Sync_Established event to the Host with the error code Operation Cancelled by Host (0x44).

Return values

0	if success.

Returns: Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.