You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ClearSoftware
Type:
SwitchKit API message
Purpose
Use the ClearSoftware message to clear system software and to reset the matrix controller or device server of the Excel platform.
Description
This message is used for clearing system software and for resetting the the matrix controller card(s).
Sent by
Application or CSA
How to use
To use a ClearSoftware message, construct the message and set the matrix and action arguments as shown below:
SKC_ClearSoftware cls();
cls.setMatrix(matrix);
cls.setAction(action);
cls.setNodeId(node);
Arguments
The following table shows the arguments you can change:
|
Arguments |
Description |
|---|---|
|
Matrix |
This argument specifies on which matrix controller card the action is applied: SK_CLEARSW_ACTIVE (1) = Apply action to active matrix controller SK_CLEARSW_STANDBY (2) = Apply action to standby matrix controller SK_CLEARSW_ALL (3) = Apply action on both matrix controller cards in the Excel platform |
|
Action |
This argument specifies which action is applied: SK_CLEARSW_CLEAR (1) = Clear software but do not reset the matrix controller. SK_CLEARSW_CLEAR_AND_RESET (2) = Clear software and reset the matrix controller. |
|
Node |
This argument specifies the logical node ID of the matrix controller pair or the Device Server ID of the Device Server card to which the action is to be applied. |
Status Field
The following table shows the possible return values of the status field. The status field can contain any of the values or the logical OR combination of two or more of the following:
|
Value |
Description |
|---|---|
|
SK_SUCCESS (0x10) |
Message successfully executed. |
|
SK_ACTIVE_NOT_ |
The active matrix controller card was not cleared. |
|
SK_STANDBY_NOT_ |
The standby matrix controller card was not cleared. |
|
SK_ACTIVE_NOT_ |
The active matrix controller card was not reset. |
|
SK_STANDBY_NOT_ |
The standby matrix controller card was not reset. |
|
SK_INVALID_NODE (0xf002) |
This indicates that the application has no description data associated with it. |
C Structure
typedef struct {
UBYTE Matrix;
UBYTE Action;
unsigned short NodeId;
} SK_ClearSoftware;
C++ Class
class SKC_ClearSoftware : public SKC_ToolkitMessage {
public:
UBYTE getMatrix() const;
void setMatrix(UBYTE x);
UBYTE getAction() const;
void setAction(UBYTE x);
unsigned short getNodeId() const
void setNodeId(unsigned short x)
};