|
Developer's Guide
|
|
|
Developer's Guide
|
|
#include <p6config.h>
Inherits P6R::p6ICom.
Public Member Functions | |
| virtual P6INT32 | addref (void)=0 |
| virtual P6R::P6ERR | closeConfigFile (P6BOOL withDefaults)=0 |
| virtual P6R::P6ERR | createConfigFile (const P6WCHAR *pPathName, P6BOOL overWrite)=0 |
| virtual P6R::P6ERR | deleteConfigItem (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName)=0 |
| virtual P6R::P6ERR | deleteConfigSection (const P6WCHAR *pSectionName)=0 |
| virtual P6R::P6ERR | enableVersionStamp (P6BOOL enabled)=0 |
| virtual P6R::P6ERR | enumConfigList (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, p6IEnumConfigWValues **ppEnum)=0 |
| virtual P6R::P6ERR | enumConfigSections (p6IEnumConfigWSections **ppEnum)=0 |
| virtual P6R::P6ERR | enumConfigValues (const P6WCHAR *pSectionName, p6IEnumConfigWValues **ppEnum)=0 |
| virtual P6R::P6ERR | flushConfigFile (const P6WCHAR *pAlternateName, P6BOOL withDefaults)=0 |
| virtual P6R::P6ERR | getConfigBool (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6BOOL defaultValue, P6BOOL *pValue)=0 |
| virtual P6R::P6ERR | getConfigDouble (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6FLOAT defaultValue, P6FLOAT *pValue)=0 |
| virtual P6R::P6ERR | getConfigInt (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6INT32 defaultValue, P6INT32 *pValue)=0 |
| virtual P6R::P6ERR | getConfigSection (const P6WCHAR *pSectionName, P6WCHAR *pReturnBuf, P6UINT32 cBuffer, P6UINT32 *pWritten)=0 |
| virtual P6R::P6ERR | getConfigString (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, const P6WCHAR *defaultValue, P6WCHAR *pBuffer, P6UINT32 cBuffer, P6UINT32 *pWritten)=0 |
| virtual P6R::P6ERR | getConfigUInt (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6UINT32 defaultValue, P6UINT32 *pValue)=0 |
| virtual P6R::P6ERR | initialize (P6CONFIGFLAGS flags, const P6CHAR *pLocale)=0 |
| virtual P6R::P6ERR | openConfigFile (P6OPENFLAGS fFlags, const P6WCHAR *pPathName)=0 |
| virtual P6R::P6ERR | queryInterface (const P6R::P6IID &iid, P6VOID **ppIface)=0 |
| virtual P6R::P6ERR | registerForNotify (P6CONFIG_NOTIFY_CODES regFor, CONFIG_NOTIFY_CHANGE pFn, P6VOID *pContext)=0 |
| virtual P6INT32 | release (void)=0 |
| virtual P6R::P6ERR | reloadConfigFile (void)=0 |
| virtual P6R::P6ERR | setConfigBool (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6BOOL value)=0 |
| virtual P6R::P6ERR | setConfigDouble (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6FLOAT value)=0 |
| virtual P6R::P6ERR | setConfigInt (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6INT32 value)=0 |
| virtual P6R::P6ERR | setConfigString (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, const P6WCHAR *pValue)=0 |
| virtual P6R::P6ERR | setConfigStringList (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, const P6WCHAR *pstrValue)=0 |
| virtual P6R::P6ERR | setConfigUInt (const P6WCHAR *pSectionName, const P6WCHAR *pKeyName, P6UINT32 value)=0 |
| virtual P6R::P6ERR | unregisterForNotify (P6CONFIG_NOTIFY_CODES regFor, CONFIG_NOTIFY_CHANGE pFn)=0 |
Provides configuration file management with multi-language support.
All IWConfg functions use P6WCHAR* (wide characters) instead of P6CHAR* (narrow characters) and are Unicode enabled.
A configuration file is composed of one or more sections each defined by a section name. Each section name must appear on a line by itself starting at column 0 with the following format: "[" <name> "]", where "[" "]" are reserved characters.
In addition to named sections, their is one unnamed section at the very start of the file. In this seciton there are only name value pairs without a section header name.
Each section is composed of one or more name value pairs of the following format: <name> "=" <value>, where <name> starts in column one. A line in a configuration file can exceed MAX_IDENTIFER_SIZE characters.
Definition at line 284 of file p6config.h.
