Module: CPKIFPathSettingsSerializer
Definition in file PathSettingsSerializer.cpp.
#include "PathSettingsSerializer.h"
#include "wx/config.h"
#include "wx/fileconf.h"
#include "pkif.h"
#include "PKIFBase64.h"
#include "wx/log.h"
#include "PRStringUtils.h"
Go to the source code of this file.
Defines | |
#define | PKIFRESOURCES_PATH_SERIALIZER TOOLKIT_APP + 2 |
Functions | |
void | SaveSettings_wx (CPKIFPathSettingsPtr &settingsToSave, wxConfigBase *conf, const char *localFile, bool useFile, bool bAllUsers, const char *pathRelToCompanyApp) |
#define PKIFRESOURCES_PATH_SERIALIZER TOOLKIT_APP + 2 |
void SaveSettings_wx | ( | CPKIFPathSettingsPtr & | settingsToSave, | |
wxConfigBase * | conf, | |||
const char * | localFile, | |||
bool | useFile, | |||
bool | bAllUsers, | |||
const char * | pathRelToCompanyApp | |||
) |
Interface: Module
SaveSettings accepts an instance of CPKIFPathSettings, a company name and an application name. The company name and the application name are used to determine where the settings stored in the CPKIFPathSettings object are stored. If no company name and no application name are supplied (i.e., the parameters are passed as NULL), then "Orion Security Solutions" is used as the company name and "PKIFv2" is used as the application name.
Prior to writing out new settings, previously existing settings are deleted. If this method does not complete successfully, previously existing settings will not be available and new settings will not be saved. If failure occurs during serialization of a particular value, the value will be indicated in the descriptive text returned via the exception object.
settingsToSave | [in]Smart pointer to a CPKIFPathSettings object containing the settings to serialize |
conf | [in]Pointer to a wxConfigBase object |
localFile | [in]Pointer to a NULL terminated string indicating a file name for use in storing the settings |
useFile | [in] Boolean value indicating if a file should be used to store settings. |
Definition at line 139 of file PathSettingsSerializer.cpp.
References B64Encode(), COMMON_UNKNOWN_ERROR, PKIFRESOURCES_PATH_SERIALIZER, and WXCASTCHARS.
Referenced by SavePathProcessingComponents(), CPKIFMediatorSerializer::SaveSettings(), and CPKIFPathSettingsSerializer::SaveSettings().