ClearLog

Type

SwitchKit API message

Description

The ClearLog message is used as an operations, administration and maintenance feature in the Converged Services Administrator (CSA) to clear log files. You can choose among different options to clear log files.

Sent by

Application or CSA

How to use

To use a ClearLog message, construct the message and set the LoggingBitMask:

SKC_ClearLog cl;

UBYTE log_bit_mask = SK_CLEAR_MSG_LOG |

SK_CLEAR_SOCKET_LOG

cl.setLoggingBitMask(log_bit_mask);

Argument Values

The following table shows the common values of the LoggingBitMask argument. You can combine two or more values with a logical OR to clear several logs at once.

Clear individual log files using the following values:

Clear groups of log files using the following values:

C Structure

typedef struct {

UBYTE LoggingBitMask;

} SK_ClearLog;

C Structure Response

typedef struct {

int Status;

} SK_ClearLogAck;

C++ Class

class SKC_ClearLog : public SKC_ToolkitMessage {

public:

UBYTE getLoggingBitMask() const;

void setLoggingBitMask(UBYTE x);

};

C++ Class Response

class SKC_ClearLogAck : public SKC_ToolkitAck {

public:

int getStatus() const;

void setStatus(int x);

};