You are here: SwitchKit® Development Environment Programmer’s Guide > 3 Channel Management > sk_clearChannelGroup()

sk_clearChannelGroup()

Description

With the function call to sk_clearChannelGroup(), LLC removes all channels from the specified group and removes the group. After calling this function, if a request channel was sent for the group removed, LLC would return a response of "invalid group". Use the sk_removeChannelsFromGroup() function to remove individual channels from a channel group. The sk_clearChannelGroup()function is also available as sk_clearChannelGroupOnConnection() and skts_clearChannelGroup().

Syntax

int sk_clearChannelGroup(char *group);

int sk_clearChannelGroupOn Connection(char *group, int aConID);

int skts_clearChannelGroup(char *aChannelGroup, int aConID );

Parameters

The function parameters are shown in the table below.

Argument | Description
--- | ---
aChannelGroup | Identifies the channel group.
aConID | aConID is a connection identifier specified at connection creation time and used to indicate which LLC an application wishes to communicate with.

Return Values

Possible return values for this function:

SK_LOST_LLC | This return value indicates that your application lost contact with the LLC.