nrfxlib API 3.3.99
Loading...
Searching...
No Matches

◆ sdc_hci_cmd_le_remove_cig()

uint8_t sdc_hci_cmd_le_remove_cig ( const sdc_hci_cmd_le_remove_cig_t * p_params,
sdc_hci_cmd_le_remove_cig_return_t * p_return )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Remove CIG.

The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.100

This command is used by the Central’s Host to remove the CIG identified by CIG_ID.

The CIG_ID parameter contains the identifier of the CIG.

This command shall delete the CIG_ID and also delete the Connection_Handles of the CIS configurations stored in the CIG.

This command shall also remove the isochronous data paths that are associated with the Connection_Handles of the CIS configurations, which is equivalent to issuing the HCI_LE_Remove_ISO_Data_Path command (see Section 7.8.110).

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                         Error code
MC     The CIG is in the active state.   Command Disallowed (0x0C)
MC     The CIG_ID does not exist.        Unknown Connection Identifier (0x02)

Event(s) generated (unless masked away):

When the HCI_LE_Remove_CIG command has completed, an HCI_Command_Complete event shall be generated.

Parameters
[in]p_paramsInput parameters.
[out]p_returnExtra return parameters.
Return values
0if 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.