You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Remove Channels From Group
Type
SwitchKit API message
Description
Use this message to remove channels from an existing channel group.
Sent by
SwitchManager or Application
Configuration
RemoveChannelsFromGroup(
ChannelGroup = quoted string,
range = startSpan:startChannel - endSpan:endChannel);
C Structure
typedef struct {
BaseFields Base;
unsigned short StartSpan;
unsigned short EndSpan;
UBYTE StartChannel;
UBYTE EndChannel;
char ChannelGroup[45];
UBYTE reserved68[16];
} SK_RemoveChannelsFromGroup;
C++ Class
class SKC_RemoveChannelsFromGroup: public SKC_AdminMessage {
public:
SKC_RemoveChannelsFromGroup(int sz = 0); ~SKC_RemoveChannelsFromGroup(); SK_DECLARE_CLASS(SKC_RemoveChannelsFromGroup,SKC_AdminMessage)
virtual MsgStruct *getStructPtr();
virtual const MsgStruct *getStructPtr() const;
virtual int getTag() const;
unsigned short getStartSpan() const;
void setStartSpan(unsigned short x);
unsigned short getEndSpan() const;
void setEndSpan(unsigned short x);
UBYTE getStartChannel() const;
void setStartChannel(UBYTE x);
UBYTE getEndChannel() const;
void setEndChannel(UBYTE x);
const char *getChannelGroup() const;
void setChannelGroup(const char *x);
};
Example
The following is an example of RemoveChannelsFromGroup for Channel Group "all", with a range of span 0/channel 2 - span 1/channel 3.
RemoveChannelsFromGroup(
ChannelGroup="all",
Range=0:2-1:3);