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

WriteCfgFile

Type

SwitchKit API message

Purpose

Use the SK_WriteCfgFile message to instruct SwitchManager to write the configuration file.

Description

When this message is received by SwitchManager, it will search through its database of messages for each slot on each node. Each message will be written to the new file.

Sent by

Application

Arguments

The following table shows the user modifiable arguments:

Argument | Description
--- | ---
Filename | The name of the file to write to. If blank (e.g. ""), then SwitchManager will write to a filename derived from the input file. For example, if the original file is myConfig.cfg and no filename is provided to SK_WriteCfg, the first time SK_WriteCfg is called, the output name will be myConfig_1.cfg.

C Structure

typedef struct {

char Filename[230];

} SK_WriteCfgFile;

C Structure Response

typedef struct {

int Status;

} SK_WriteCfgFileAck;

C++ Class

class SKC_WriteCfgFile : public SKC_ToolkitMessage {

public:

const char *getFilename() const;

void setFilename(const char *x);

};

C++ Class Response

class SKC_WriteCfgFileAck : public SKC_ToolkitAck {

public:

int getStatus() const;

void setStatus(int x);

const UBYTE *getReserved() const;

UBYTE *getReserved();

void setReserved(UBYTE *x);

};