class PConfig: public PObject

A class representing a configuration for the application.

Inheritance:


Public

[more] Construction
[more] Section functions
[more] Get/Set variables

Protected Fields

[more]PString defaultSection
The current section for variable values.


Inherited from PObject:

Public

Run Time Type functions

Comparison functions

I/O functions

Miscellaneous functions


Documentation

A class representing a configuration for the application. There are four sources of configuration information. The system environment, a system wide configuration file, an application specific configuration file or an explicit configuration file.

Configuration information follows a three level hierarchy: file, section and variable. Thus, a configuration file consists of a number of sections each with a number of variables selected by a key. Each variable has an associated value.

Note that the evironment source for configuration information does not have sections. The section is ignored and the same set of keys are available.

The configuration file is a standard text file for the platform with its internals appearing in the form:

     [Section String]
     Key Name=Value String
o Construction

oenum Source
Description of the standard source for configuration information

o Environment
The platform specific environment. For Unix, MSDOS, NT etc this is the environment current when the program was run. For the MacOS this is a subset of the Gestalt and SysEnviron information.

o System
The platform specific system wide configuration file. For MS-Windows this is the WIN.INI file. For Unix, plain MS-DOS, etc this is a configuration file similar to that for applications except there is only a single file that applies to all PWLib applications.

o Application
The application specific configuration file. This is the most common source of configuration for an application. The location of this file is platform dependent, but its contents are always the same. For MS-Windows the file should be either in the same directory as the executable or in the Windows directory. For the MacOS this would be either in the System Folder or the Preferences folder within it. For Unix this would be the users home directory.

o PConfig( Source src = Application )
Create a new configuration object. Once a source is selected for the configuration it cannot be changed. Only at the next level of the hierarchy (sections) are selection able to be made dynamically with an active PConfig object.
Parameters:
src - Standard source for the configuration.

o PConfig( Source src, const PString & appname )
Create a new configuration object.
Parameters:
src - Standard source for the configuration.
appname - Name of application

o PConfig( Source src, const PString & appname, const PString & manuf )
Create a new configuration object.
Parameters:
src - Standard source for the configuration.
appname - Name of application
manuf - Manufacturer

o PConfig( const PString & section, Source src = Application )
Create a new configuration object.
Parameters:
section - Default section to search for variables.
src - Standard source for the configuration.

o PConfig( const PString & section, Source src, const PString & appname )
Create a new configuration object.
Parameters:
section - Default section to search for variables.
src - Standard source for the configuration.
appname - Name of application

o PConfig( const PString & section, Source src, const PString & appname, const PString & manuf )
Create a new configuration object.
Parameters:
section - Default section to search for variables.
src - Standard source for the configuration.
appname - Name of application
manuf - Manufacturer

o PConfig( const PFilePath & filename, const PString & section )
Create a new configuration object.
Parameters:
filename - Explicit name of the configuration file.
section - Default section to search for variables.

o Section functions

ovoid SetDefaultSection( const PString & section )
Set the default section for variable operations. All functions that deal with keys and get or set configuration values will use this section unless an explicit section name is specified.

Note when the Environment source is being used the default section may be set but it is ignored.

Parameters:
section - New default section name.

oPString GetDefaultSection() const
Get the default section for variable operations. All functions that deal with keys and get or set configuration values will use this section unless an explicit section name is specified.

Note when the Environment source is being used the default section may be retrieved but it is ignored.

Returns:
default section name string.

oPStringList GetSections() const
Get all of the section names currently specified in the file. A section is the part specified by the [ and ] characters.

Note when the Environment source is being used this will return an empty list as there are no section present.

Returns:
list of all section names.

oPStringList GetKeys() const
Get a list of all the keys in the section. If the section name is not specified then use the default section.

Returns:
list of all key names.

oPStringList GetKeys( const PString & section ) const
Get a list of all the keys in the section.
Parameters:
section - Section to use instead of the default.

oPStringToString GetAllKeyValues() const
Get all of the keys in the section and their values. If the section name is not specified then use the default section.

Returns:
Dictionary of all key names and their values.

oPStringToString GetAllKeyValues( const PString & section ) const
Get all of the keys in the section and their values.
Parameters:
section - Section to use instead of the default.

ovoid DeleteSection()
Delete all variables in the specified section. If the section name is not specified then the default section is deleted.

Note that the section header is also removed so the section will not appear in the GetSections() function.

ovoid DeleteSection( const PString & section )
Delete all variables in the specified section.
Parameters:
section - Name of section to delete.

ovoid DeleteKey( const PString & key )
Delete the particular variable in the specified section. If the section name is not specified then the default section is used.

Note that the variable and key are removed from the file. The key will no longer appear in the GetKeys() function. If you wish to delete the value without deleting the key, use SetString() to set it to the empty string.

Parameters:
key - Key of the variable to delete.

ovoid DeleteKey( const PString & section, const PString & key )
Delete the particular variable in the specified section.
Parameters:
section - Section to use instead of the default.
key - Key of the variable to delete.

oBOOL HasKey( const PString & key ) const
Determine if the particular variable in the section is actually present.

This function allows a caller to distinguish between getting a saved value or using the default value. For example if you called GetString("MyKey", "DefVal") there is no way to distinguish between the default "DefVal" being used, or the user had explicitly saved the value "DefVal" into the PConfig.

Parameters:
key - Key of the variable.

oBOOL HasKey( const PString & section, const PString & key ) const
Determine if the particular variable in the section is actually present.
Parameters:
section - Section to use instead of the default.
key - Key of the variable.

o Get/Set variables

oPString GetString( const PString & key ) const
Get a string variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the dlft parameter. Note that this is different from the key being present but having no value, in which case an empty string is returned.

Returns:
string value of the variable.
Parameters:
key - The key name for the variable.

oPString GetString( const PString & key, const PString & dflt ) const
Get a string variable determined by the key in the section.
Parameters:
key - The key name for the variable.
dflt - Default value for the variable.

oPString GetString( const PString & section, const PString & key, const PString & dflt ) const
Get a string variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
dflt - Default value for the variable.

ovoid SetString( const PString & key, const PString & value )
Set a string variable determined by the key in the section. If the section name is not specified then the default section is used.
Parameters:
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetString( const PString & section, const PString & key, const PString & value )
Set a string variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
value - New value to set for the variable.

oBOOL GetBoolean( const PString & key, BOOL dflt = FALSE ) const
Get a boolean variable determined by the key in the section. If the section name is not specified then the default section is used.

The boolean value can be specified in a number of ways. The TRUE value is returned if the string value for the variable begins with either the 'T' character or the 'Y' character. Alternatively if the string can be converted to a numeric value, a non-zero value will also return TRUE. Thus the values can be Key=True, Key=Yes or Key=1 for TRUE and Key=False, Key=No, or Key=0 for FALSE.

If the key is not present the value returned is the that provided by the dlft parameter. Note that this is different from the key being present but having no value, in which case FALSE is returned.

Returns:
boolean value of the variable.
Parameters:
key - The key name for the variable.
dflt - Default value for the variable.

oBOOL GetBoolean( const PString & section, const PString & key, BOOL dflt = FALSE ) const
Get a boolean variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
dflt - Default value for the variable.

ovoid SetBoolean( const PString & key, BOOL value )
Set a boolean variable determined by the key in the section. If the section name is not specified then the default section is used.

If value is TRUE then the string "True" is written to the variable otherwise the string "False" is set.

Parameters:
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetBoolean( const PString & section, const PString & key, BOOL value )
Set a boolean variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetInteger( const PString & key, long value )
Set an integer variable determined by the key in the section. If the section name is not specified then the default section is used.

The value is always formatted as a signed number with no leading or trailing blanks.

Parameters:
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetInteger( const PString & section, const PString & key, long value )
Set an integer variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
value - New value to set for the variable.

oPInt64 GetInt64( const PString & key, PInt64 dflt = 0 ) const
Get a 64 bit integer variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the dlft parameter. Note that this is different from the key being present but having no value, in which case zero is returned.

Returns:
integer value of the variable.
Parameters:
key - The key name for the variable.
dflt - Default value for the variable.

oPInt64 GetInt64( const PString & section, const PString & key, PInt64 dflt = 0 ) const
Get a 64 bit integer variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
dflt - Default value for the variable.

ovoid SetInt64( const PString & key, PInt64 value )
Set a 64 bit integer variable determined by the key in the section. If the section name is not specified then the default section is used.

The value is always formatted as a signed number with no leading or trailing blanks.

Parameters:
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetInt64( const PString & section, const PString & key, PInt64 value )
Set a 64 bit integer variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
value - New value to set for the variable.

odouble GetReal( const PString & key, double dflt = 0 ) const
Get a floating point variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the dlft parameter. Note that this is different from the key being present but having no value, in which case zero is returned.

Returns:
floating point value of the variable.
Parameters:
key - The key name for the variable.
dflt - Default value for the variable.

odouble GetReal( const PString & section, const PString & key, double dflt = 0 ) const
Get a floating point variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
dflt - Default value for the variable.

ovoid SetReal( const PString & key, double value )
Set a floating point variable determined by the key in the section. If the section name is not specified then the default section is used.

The value is always formatted as a signed decimal or exponential form number with no leading or trailing blanks, ie it uses the %g formatter from the printf() function.

Parameters:
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetReal( const PString & section, const PString & key, double value )
Set a floating point variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
value - New value to set for the variable.

oPTime GetTime( const PString & key ) const
Get a PTime variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the dlft parameter. Note that this is different from the key being present but having no value, in which case zero is returned.

Returns:
time/date value of the variable.
Parameters:
key - The key name for the variable.

oPTime GetTime( const PString & key, const PTime & dflt ) const
Get a PTime variable determined by the key in the section.
Parameters:
key - The key name for the variable.
dflt - Default value for the variable.

oPTime GetTime( const PString & section, const PString & key ) const
Get a PTime variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.

oPTime GetTime( const PString & section, const PString & key, const PTime & dflt ) const
Get a PTime variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
dflt - Default value for the variable.

ovoid SetTime( const PString & key, const PTime & value )
Set a PTime variable determined by the key in the section. If the section name is not specified then the default section is used.
Parameters:
key - The key name for the variable.
value - New value to set for the variable.

ovoid SetTime( const PString & section, const PString & key, const PTime & value )
Set a PTime variable determined by the key in the section.
Parameters:
section - Section to use instead of the default.
key - The key name for the variable.
value - New value to set for the variable.

oPString defaultSection
The current section for variable values.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.