You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ForceGroupState

ForceGroupState

Type

EXS SwitchKit API message

Purpose

This message causes the LLC to take action on all of the channels within the group specified by the ChannelGroup field. This will only affect channels not currently owned or watched by another application.

Sent by

SwitchKit Application

Arguments

The following table shows the arguments you can change:

Argument | Description
--- | ---
ChannelGroup | The name of the group this action should be performed on.
action | The state the LLC is requesting this channel be put into. Values for ForceGroupState actions: SK_OUT_OF_SERVICE =0x0F SK_IN_SERVICE =0xF0
int status | This is a response argument. The values are: SK_INVALID_GROUP - No valid channel group was found. OK - Success

Response Arguments

Argument | Description
--- | ---
ChannelGroup | The name of the group this action should be performed on.
int status | The values for this argument are: SK_INVALID_GROUP - No valid channel group was found. OK - Success

C Structure

typedef struct {

char ChannelGroup[50];

unsigned short Action;

UBYTE reserved69[4];

} SK_ForceGroupState;

C Structure Response

typedef struct {

char ChannelGroup[50];

int Status;

UBYTE reserved71[4];

} SK_ForceGroupStateAck;

C++ Class

class SKC_ForceGroupState : public SKC_ToolkitMessage {

public:

const char *getChannelGroup() const;

void setChannelGroup(const char *x);

unsigned short getAction() const;

void setAction(unsigned short x);

};

C++ Class Response

class SKC_ForceGroupStateAck : public SKC_ToolkitAck {

public:

const char *getChannelGroup() const;

void setChannelGroup(const char *x);

int getStatus() const;

void setStatus(int x);

};